type HashMap = Record; type nullish = null | undefined; type GroupKey = Exclude; interface IHandle { remove(): void; } interface __geosceneImplementsIteration { [Symbol.iterator](): IterableIterator; } declare namespace __geoscene { export class Accessor { destroyed: boolean; initialized: boolean; declaredClass: string; /** * Accessor is an abstract class that facilitates the access to instance properties as well as a mechanism to watch for property changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Accessor.html Read more...} */ constructor(obj?: any); destroy(): void; 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 { set?(propertyName: string, value: T): this; set?(props: HashMap): this; watch?(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle; } export type ReadonlyAccessor = Omit; 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, array: T[]) => 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, __geosceneImplementsIteration { 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 interface ReadonlyCollection extends ReadonlyAccessor { readonly length: number; at(index: number): T | undefined; clone(): Collection; concat(value: T[] | Collection): Collection; every(callback: ItemTestCallback): boolean; filter(callback: (item: T, index: number, array: T[]) => item is S): Collection; filter(callback: ItemTestCallback): Collection; find(callback: ItemTestCallback): T | undefined; 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 | undefined; includes(searchElement: T): boolean; indexOf(searchElement: T, fromIndex?: number): number; join(separator?: string): string; lastIndexOf(searchElement: T, fromIndex?: number): number; map(callback: ItemMapCallback): Collection; reduce(callback: ItemReduceCallback, initialValue?: R): R; reduceRight(callback: ItemReduceCallback, initialValue?: R): R; slice(begin?: number, end?: number): Collection; some(callback: ItemTestCallback): boolean; toArray(): T[]; } export class Collection extends Accessor { readonly length: number; /** * Collection stores an array of items of the same type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Read more...} */ constructor(values?: any[] | Collection); at(index: number): T | undefined; 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: (item: T, index: number, array: T[]) => item is S): Collection; filter(callback: ItemTestCallback): Collection; find(callback: ItemTestCallback): T | undefined; 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 | undefined; 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 | undefined; push(item: T): number; reduce(callback: ItemReduceCallback, initialValue?: R): R; reduceRight(callback: ItemReduceCallback, initialValue?: R): R; remove(item: T): T | undefined; removeAll(): T[]; removeAt(index: number): T | undefined; removeMany(items: T[] | Collection): T[]; reorder(item: T, index: number): T | undefined; reverse(): this; shift(): T | undefined; slice(begin?: number, end?: number): Collection; some(callback: ItemTestCallback): 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; type DateProperties = number | string | Date; type ColorProperties = readonly number[] | string | { r?: number; g?: number; b?: number; a?: number }; 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 | undefined) => void, options?: ReactiveWatchOptions): IHandle; when(getValue: () => T | nullish, callback: (newValue: T, oldValue: T | nullish) => void, options?: ReactiveWatchOptions): IHandle; on(getTarget: () => T | nullish, eventName: string, callback: (value: any) => void, options?: ReactiveListenerOptions): IHandle; once(getValue: () => T, signal?: AbortSignal | { signal?: AbortSignal } | nullish): Promise; whenOnce(getValue: () => T | nullish, signal?: AbortSignal | { signal?: AbortSignal } | nullish): Promise; } export const reactiveUtils: reactiveUtils; export interface Signal { value: T; mutate(mutateFn: (value: T) => void): void; } export interface __ReactiveObservable { notify(): void; } export interface __ReactiveTrackingTarget { clear(): void; destroy(): void; } interface ComponentsReactiveUtils { signal(initialValue: T, equalityFunction?: (a: T, b: T) => boolean): Signal; createObservable(): __ReactiveObservable; createTrackingTarget(callback: () => void): __ReactiveTrackingTarget; trackAccess(observable: __ReactiveObservable): void; runTracked(target: __ReactiveTrackingTarget, callback: () => T): T | null; } export const ComponentsReactiveUtils: ComponentsReactiveUtils; 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 BatchAttributeFormSubmitEventHandler = (event: BatchAttributeFormSubmitEvent) => void; export type BatchAttributeFormValueChangeEventHandler = (event: BatchAttributeFormValueChangeEvent) => void; export type BatchAttributeFormViewModelSubmitEventHandler = (event: BatchAttributeFormViewModelSubmitEvent) => void; export type BatchAttributeFormViewModelValueChangeEventHandler = ( event: BatchAttributeFormViewModelValueChangeEvent, ) => 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 CatalogLayerLayerviewCreateErrorEventHandler = (event: CatalogLayerLayerviewCreateErrorEvent) => void; export type CatalogLayerLayerviewCreateEventHandler = (event: CatalogLayerLayerviewCreateEvent) => void; export type CatalogLayerLayerviewDestroyEventHandler = (event: CatalogLayerLayerviewDestroyEvent) => void; export type CatalogLayerListTriggerActionEventHandler = (event: CatalogLayerListTriggerActionEvent) => void; export type CatalogLayerListViewModelTriggerActionEventHandler = ( event: CatalogLayerListViewModelTriggerActionEvent, ) => void; export type CatalogLayerRefreshEventHandler = (event: CatalogLayerRefreshEvent) => 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 DaylightUserDateTimeChangeEventHandler = (event: DaylightUserDateTimeChangeEvent) => void; export type DaylightViewModelUserDateTimeChangeEventHandler = ( event: DaylightViewModelUserDateTimeChangeEvent, ) => 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 FeatureTableCellClickEventHandler = (event: FeatureTableCellClickEvent) => void; export type FeatureTableCellDblclickEventHandler = (event: FeatureTableCellDblclickEvent) => void; export type FeatureTableCellKeydownEventHandler = (event: FeatureTableCellKeydownEvent) => void; export type FeatureTableCellPointeroutEventHandler = (event: FeatureTableCellPointeroutEvent) => void; export type FeatureTableCellPointeroverEventHandler = (event: FeatureTableCellPointeroverEvent) => void; export type FeatureTableColumnReorderEventHandler = (event: FeatureTableColumnReorderEvent) => void; export type FeatureTableViewModelCellClickEventHandler = (event: FeatureTableViewModelCellClickEvent) => void; export type FeatureTableViewModelCellDblclickEventHandler = (event: FeatureTableViewModelCellDblclickEvent) => void; export type FeatureTableViewModelCellKeydownEventHandler = (event: FeatureTableViewModelCellKeydownEvent) => void; export type FeatureTableViewModelCellPointeroutEventHandler = ( event: FeatureTableViewModelCellPointeroutEvent, ) => void; export type FeatureTableViewModelCellPointeroverEventHandler = ( event: FeatureTableViewModelCellPointeroverEvent, ) => void; export type FeatureTableViewModelColumnReorderEventHandler = (event: FeatureTableViewModelColumnReorderEvent) => 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 LinkChartLayoutSwitcherViewModelSwitchLayoutEventHandler = ( event: LinkChartLayoutSwitcherViewModelSwitchLayoutEvent, ) => void; export type LocateLocateErrorEventHandler = (event: LocateLocateErrorEvent) => void; export type LocateLocateEventHandler = (event: LocateLocateEvent) => void; export type LocateViewModelLocateErrorEventHandler = (event: LocateViewModelLocateErrorEvent) => void; export type LocateViewModelLocateEventHandler = (event: LocateViewModelLocateEvent) => 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 Analysis extends Accessor, Clonable, Identifiable { } export class Analysis { /** * A user settable identifier for the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#id Read more...} */ id: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Abstract base class for all analysis objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html Read more...} */ constructor(properties?: AnalysisProperties); /** * The origin of the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#origin Read more...} */ get origin(): AnalysisOriginWebScene | nullish; set origin(value: (AnalysisOriginWebSceneProperties & { type: "web-scene" }) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#clone Read more...} */ clone(): this; } interface AnalysisProperties extends IdentifiableProperties { /** * A user settable identifier for the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#id Read more...} */ id?: string; /** * The origin of the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Analysis.html#origin Read more...} */ origin?: (AnalysisOriginWebSceneProperties & { type: "web-scene" }) | nullish; } export class AreaMeasurementAnalysis extends Analysis { /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#type Read more...} */ readonly type: "area-measurement"; /** * Unit system (imperial, metric) or specific unit used for displaying the computed area in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#unit Read more...} */ unit: SystemOrAreaUnit | nullish; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * AreaMeasurementAnalysis computes the area of a polygonal region and displays the measurement * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html Read more...} */ constructor(properties?: AreaMeasurementAnalysisProperties); /** * Polygon whose area is to be computed and displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#geometry Read more...} */ get geometry(): Polygon | nullish; set geometry(value: PolygonProperties | nullish); } interface AreaMeasurementAnalysisProperties extends AnalysisProperties { /** * Polygon whose area is to be computed and displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#geometry Read more...} */ geometry?: PolygonProperties | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the computed area in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html#unit Read more...} */ unit?: SystemOrAreaUnit | nullish; } export class DimensionAnalysis extends Analysis { /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#type Read more...} */ readonly type: "dimension"; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * DimensionAnalysis enables the creation and display of measurement annotations for lengths and distances in a 3D * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html Read more...} */ constructor(properties?: DimensionAnalysisProperties); /** * A list of dimensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#dimensions Read more...} */ get dimensions(): Collection; set dimensions(value: CollectionProperties); /** * The style defines how the dimension objects of this analysis are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#style Read more...} */ get style(): DimensionSimpleStyle; set style(value: DimensionSimpleStyleProperties & { type: "simple" }); } interface DimensionAnalysisProperties extends AnalysisProperties { /** * A list of dimensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#dimensions Read more...} */ dimensions?: CollectionProperties; /** * The style defines how the dimension objects of this analysis are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html#style Read more...} */ style?: DimensionSimpleStyleProperties & { type: "simple" }; } export interface DimensionSimpleStyle extends Accessor, Clonable { } export class DimensionSimpleStyle { readonly type: "simple"; /** * Style that specifies how dimensions and their labels are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html Read more...} */ constructor(properties?: DimensionSimpleStyleProperties); /** * Color of dimension lines. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Size of text in dimension labels in points. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#fontSize Read more...} */ get fontSize(): number; set fontSize(value: number | string); /** * Width of dimension lines in points. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#lineSize Read more...} */ get lineSize(): number; set lineSize(value: number | string); /** * Background color of dimension labels. * * @default [255, 255, 255, 0.6] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#textBackgroundColor Read more...} */ get textBackgroundColor(): Color; set textBackgroundColor(value: ColorProperties); /** * Color of text in dimension labels. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#textColor Read more...} */ get textColor(): Color; set textColor(value: ColorProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#clone Read more...} */ clone(): this; } interface DimensionSimpleStyleProperties { /** * Color of dimension lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#color Read more...} */ color?: ColorProperties; /** * Size of text in dimension labels in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#fontSize Read more...} */ fontSize?: number | string; /** * Width of dimension lines in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#lineSize Read more...} */ lineSize?: number | string; /** * Background color of dimension labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#textBackgroundColor Read more...} */ textBackgroundColor?: ColorProperties; /** * Color of text in dimension labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionSimpleStyle.html#textColor Read more...} */ textColor?: ColorProperties; } export class DirectLineMeasurementAnalysis extends Analysis { /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#type Read more...} */ readonly type: "direct-line-measurement"; /** * Unit system (imperial, metric) or specific unit used for computing the distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#unit Read more...} */ unit: SystemOrLengthUnit | nullish; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * DirectLineMeasurementAnalysis computes the distance between two points and displays the measurement * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html Read more...} */ constructor(properties?: DirectLineMeasurementAnalysisProperties); /** * Ending point for the measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#endPoint Read more...} */ get endPoint(): Point | nullish; set endPoint(value: PointProperties | nullish); /** * Starting point for the measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#startPoint Read more...} */ get startPoint(): Point | nullish; set startPoint(value: PointProperties | nullish); } interface DirectLineMeasurementAnalysisProperties extends AnalysisProperties { /** * Ending point for the measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#endPoint Read more...} */ endPoint?: PointProperties | nullish; /** * Starting point for the measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#startPoint Read more...} */ startPoint?: PointProperties | nullish; /** * Unit system (imperial, metric) or specific unit used for computing the distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html#unit Read more...} */ unit?: SystemOrLengthUnit | nullish; } export interface LengthDimension extends Accessor, Clonable { } export class LengthDimension { /** * The type of length that should be measured between the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint startPoint} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint endPoint}. * * @default "direct" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#measureType Read more...} */ measureType: "direct" | "horizontal" | "vertical"; /** * Styling option that controls the shortest distance from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint startPoint} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint endPoint} to the dimension line in meters. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#offset Read more...} */ offset: number; /** * The orientation determines the relative direction the dimension line is extended to. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#orientation Read more...} */ orientation: number; /** * Indicates whether the dimension is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#valid Read more...} */ readonly valid: boolean; /** * LengthDimension enables the measurement of linear distances between the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint start} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint end} points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html Read more...} */ constructor(properties?: LengthDimensionProperties); /** * Ending point for the dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint Read more...} */ get endPoint(): Point | nullish; set endPoint(value: PointProperties | nullish); /** * Starting point for the dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint Read more...} */ get startPoint(): Point | nullish; set startPoint(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#clone Read more...} */ clone(): this; } interface LengthDimensionProperties { /** * Ending point for the dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint Read more...} */ endPoint?: PointProperties | nullish; /** * The type of length that should be measured between the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint startPoint} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint endPoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#measureType Read more...} */ measureType?: "direct" | "horizontal" | "vertical"; /** * Styling option that controls the shortest distance from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint startPoint} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#endPoint endPoint} to the dimension line in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#offset Read more...} */ offset?: number; /** * The orientation determines the relative direction the dimension line is extended to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#orientation Read more...} */ orientation?: number; /** * Starting point for the dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LengthDimension.html#startPoint Read more...} */ startPoint?: PointProperties | nullish; } export class LineOfSightAnalysis extends Analysis { /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#type Read more...} */ readonly type: "line-of-sight"; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * LineOfSightAnalysis computes the line of sight from a single observer position towards * a set of targets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html Read more...} */ constructor(properties?: LineOfSightAnalysisProperties); /** * Observer location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#observer Read more...} */ get observer(): LineOfSightAnalysisObserver | nullish; set observer(value: LineOfSightAnalysisObserverProperties | nullish); /** * Target locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#targets Read more...} */ get targets(): Collection; set targets(value: CollectionProperties); } interface LineOfSightAnalysisProperties extends AnalysisProperties { /** * Observer location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#observer Read more...} */ observer?: LineOfSightAnalysisObserverProperties | nullish; /** * Target locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#targets Read more...} */ targets?: CollectionProperties; } export interface LineOfSightAnalysisFeatureReference { layer: LineOfSightAnalysisFeatureReferenceLayer | nullish; attributes: any; } export interface LineOfSightAnalysisFeatureReferenceLayer { id: string | number; objectIdField?: string | nullish; } export interface LineOfSightAnalysisObserver extends Accessor, Clonable { } export class LineOfSightAnalysisObserver { /** * References a feature which is excluded from the intersection testing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#feature Read more...} */ feature: LineOfSightAnalysisFeatureReference | nullish; /** * The LineOfSightAnalysisObserver represents an observer of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html LineOfSightAnalysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html Read more...} */ constructor(properties?: LineOfSightAnalysisObserverProperties); /** * Specifies how the observer is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#elevationInfo Read more...} */ get elevationInfo(): LineOfSightAnalysisObserverElevationInfo | nullish; set elevationInfo(value: LineOfSightAnalysisObserverElevationInfoProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the position of the observer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#position Read more...} */ get position(): Point | nullish; set position(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#clone Read more...} */ clone(): this; } interface LineOfSightAnalysisObserverProperties { /** * Specifies how the observer is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#elevationInfo Read more...} */ elevationInfo?: LineOfSightAnalysisObserverElevationInfoProperties | nullish; /** * References a feature which is excluded from the intersection testing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#feature Read more...} */ feature?: LineOfSightAnalysisFeatureReference | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the position of the observer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisObserver.html#position Read more...} */ position?: PointProperties | nullish; } export interface LineOfSightAnalysisObserverElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; } export interface LineOfSightAnalysisObserverElevationInfo extends AnonymousAccessor { mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; } export interface LineOfSightAnalysisTarget extends Accessor, Clonable { } export class LineOfSightAnalysisTarget { /** * References a feature which is excluded from the intersection testing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#feature Read more...} */ feature: LineOfSightAnalysisFeatureReference | nullish; /** * The LineOfSightAnalysisTarget represents a target of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html LineOfSightAnalysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html Read more...} */ constructor(properties?: LineOfSightAnalysisTargetProperties); /** * Specifies how the target is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#elevationInfo Read more...} */ get elevationInfo(): LineOfSightAnalysisTargetElevationInfo | nullish; set elevationInfo(value: LineOfSightAnalysisTargetElevationInfoProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the position of the target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#position Read more...} */ get position(): Point | nullish; set position(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#clone Read more...} */ clone(): this; } interface LineOfSightAnalysisTargetProperties { /** * Specifies how the target is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#elevationInfo Read more...} */ elevationInfo?: LineOfSightAnalysisTargetElevationInfoProperties | nullish; /** * References a feature which is excluded from the intersection testing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#feature Read more...} */ feature?: LineOfSightAnalysisFeatureReference | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the position of the target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysisTarget.html#position Read more...} */ position?: PointProperties | nullish; } export interface LineOfSightAnalysisTargetElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; } export interface LineOfSightAnalysisTargetElevationInfo extends AnonymousAccessor { mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; } export class SliceAnalysis extends Analysis { /** * A flag that indicates whether the ground surface should be excluded from the slice analysis. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#excludeGroundSurface Read more...} */ excludeGroundSurface: boolean; /** * Whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#shape shape} supports a tilt angle or not. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#tiltEnabled Read more...} */ tiltEnabled: boolean; /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#type Read more...} */ readonly type: "slice"; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * SliceAnalysis can be used to programmatically create a plane that slices through 3D features in a * 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html Read more...} */ constructor(properties?: SliceAnalysisProperties); /** * A collection of layers that should be excluded from the slice analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#excludedLayers Read more...} */ get excludedLayers(): Collection; set excludedLayers(value: CollectionProperties); /** * The shape used to slice elements in a 3D scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#shape Read more...} */ get shape(): SlicePlane | nullish; set shape(value: (SlicePlaneProperties & { type: "plane" }) | nullish); } interface SliceAnalysisProperties extends AnalysisProperties { /** * A collection of layers that should be excluded from the slice analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#excludedLayers Read more...} */ excludedLayers?: CollectionProperties; /** * A flag that indicates whether the ground surface should be excluded from the slice analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#excludeGroundSurface Read more...} */ excludeGroundSurface?: boolean; /** * The shape used to slice elements in a 3D scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#shape Read more...} */ shape?: (SlicePlaneProperties & { type: "plane" }) | nullish; /** * Whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#shape shape} supports a tilt angle or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html#tiltEnabled Read more...} */ tiltEnabled?: boolean; } export interface SlicePlane extends Accessor, JSONSupport, Clonable { } export class SlicePlane { /** * The heading angle (in degrees) of the slice plane. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#heading Read more...} */ heading: number; /** * The height of the slice plane. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#height Read more...} */ height: number; /** * The tilt angle (in degrees) of the slice plane. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#tilt Read more...} */ tilt: number; /** * The string value representing the type of the slice shape. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#type Read more...} */ readonly type: "plane"; /** * The width of the slice plane. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#width Read more...} */ width: number; /** * Provides the shape definition of a slice plane for a {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-slice/ Slice component} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html SliceAnalysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html Read more...} */ constructor(properties?: SlicePlaneProperties); /** * A point specifying the position of the center of the plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#position Read more...} */ get position(): Point | nullish; set position(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SlicePlane; } interface SlicePlaneProperties { /** * The heading angle (in degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#heading Read more...} */ heading?: number; /** * The height of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#height Read more...} */ height?: number; /** * A point specifying the position of the center of the plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#position Read more...} */ position?: PointProperties | nullish; /** * The tilt angle (in degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#tilt Read more...} */ tilt?: number; /** * The width of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SlicePlane.html#width Read more...} */ width?: number; } export interface AnalysisOriginWebScene extends Accessor, Clonable { } export class AnalysisOriginWebScene { /** * The type of the analysis origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-support-AnalysisOriginWebScene.html#type Read more...} */ readonly type: "web-scene"; /** * An analysis origin indicating that the analysis was created or applied from a web scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-support-AnalysisOriginWebScene.html Read more...} */ constructor(properties?: AnalysisOriginWebSceneProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-support-AnalysisOriginWebScene.html#clone Read more...} */ clone(): this; } interface AnalysisOriginWebSceneProperties { } export interface Viewshed extends Accessor, Clonable { } export class Viewshed { /** * The maximum distance from the observer in which to perform the viewshed analysis (in meters). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#farDistance Read more...} */ farDistance: number; /** * References a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#feature Read more...} */ feature: ViewshedFeatureReference | nullish; /** * The compass heading of the observer's view direction (in degrees). * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#heading Read more...} */ heading: number; /** * The horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees). * * @default 45 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#horizontalFieldOfView Read more...} */ horizontalFieldOfView: number; /** * The tilt of the observer's view direction (in degrees). * * @default 90 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#tilt Read more...} */ tilt: number; /** * Indicates whether the viewshed is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#valid Read more...} */ readonly valid: boolean; /** * The vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees). * * @default 45 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#verticalFieldOfView Read more...} */ verticalFieldOfView: number; /** * Viewshed defines the geometry for a viewshed analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html Read more...} */ constructor(properties?: ViewshedProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} specifying the position the viewshed is calculated from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#observer Read more...} */ get observer(): Point | nullish; set observer(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#clone Read more...} */ clone(): this; } interface ViewshedProperties { /** * The maximum distance from the observer in which to perform the viewshed analysis (in meters). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#farDistance Read more...} */ farDistance?: number; /** * References a feature from which the observer is internally offset, provided that its geometry faces are close enough to the observer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#feature Read more...} */ feature?: ViewshedFeatureReference | nullish; /** * The compass heading of the observer's view direction (in degrees). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#heading Read more...} */ heading?: number; /** * The horizontal field of view (FOV) angle defines the width of the scope being analyzed (in degrees). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#horizontalFieldOfView Read more...} */ horizontalFieldOfView?: number; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} specifying the position the viewshed is calculated from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#observer Read more...} */ observer?: PointProperties | nullish; /** * The tilt of the observer's view direction (in degrees). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#tilt Read more...} */ tilt?: number; /** * The vertical field of view (FOV) angle defines the height of the scope being analyzed (in degrees). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-Viewshed.html#verticalFieldOfView Read more...} */ verticalFieldOfView?: number; } export interface ViewshedFeatureReference { layer: ViewshedFeatureReferenceLayer | nullish; attributes: any; } export class ViewshedAnalysis extends Analysis { /** * The type of analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html#type Read more...} */ readonly type: "viewshed"; /** * Indicates whether the analysis is ready to be computed and interacted with in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html#valid Read more...} */ readonly valid: boolean; /** * ViewshedAnalysis enables the creation and display of viewshed and view dome type of visibility analysis in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html Read more...} */ constructor(properties?: ViewshedAnalysisProperties); /** * A list of viewsheds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html#viewsheds Read more...} */ get viewsheds(): Collection; set viewsheds(value: CollectionProperties); } interface ViewshedAnalysisProperties extends AnalysisProperties { /** * A list of viewsheds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html#viewsheds Read more...} */ viewsheds?: CollectionProperties; } export interface ViewshedFeatureReferenceLayer { id: string | number; objectIdField?: string | nullish; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Analysis utility functions for Web Components. */ interface analysisUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Forces the analysis view to be interactive until the returned handle is removed. * * @param analysisView The analysis view whose `interactive` property is to be forced to `true`. */ forceInteractive(analysisView: AnalysisViewUnion): Handle; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Gets whether the specified analysis view contains a valid result. * * @param analysisView The analysis view to check. */ hasValidAreaResult(analysisView: AreaMeasurementAnalysisView3D): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Gets whether the specified length is above the geodesic distance threshold. * * @param length The length to check. */ isAboveGeodesicDistanceThreshold(length: Length): boolean; } export const analysisUtils: analysisUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Basemap utils for Components. */ interface basemapUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Get the thumbnail url of an geoscene basemap. * * @param basemap */ getBasemapThumbnailUrl(basemap: Basemap | nullish): string | nullish; } export const basemapUtils: basemapUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Draw utils for Components. */ interface drawUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * performs translation of given geometry * dx, dy: how much to translate the geometry in x and y direction. * * @param geometry * @param dx * @param dy * @param dz */ move(geometry: any, dx: number, dy: number, dz?: number): any; } export const drawUtils: drawUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Font utils for Components. */ interface fontUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * loads the FontFace associated with a specific * font family, style, and weight. * * @param font */ loadFont(font: any): Promise; } export const fontUtils: fontUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Extract default units from map of view. */ interface getDefaultUnits { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Extracts the default unit preferences defined the portal instance * of a webmap/webscene used in a a view. * * @param view */ getDefaultUnitForView(view: MapView | SceneView): "imperial" | "metric"; } export const getDefaultUnits: getDefaultUnits; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Background theme utils for Components. */ interface gfxUtils { defaultThematicColor: Color; } export const gfxUtils: gfxUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Layer origin utils for Components. */ interface layerOriginUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Clears property overrides in the given layer. * * @param layer * @param origin */ clearOverrides(layer: any, origin: any): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Disconnects the given layer from its source. * * @param layer * @param origin */ disconnectFromSource(layer: any, origin: any): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns origin information for properties of the given layer and overall status of the layer. * * @param layer * @param origin */ getLayerOriginInfo(layer: any, origin: any): any | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Indicates whether origin info can be returned for the given layer and its properties. * * @param layer */ isSupportedLayer(layer: any): boolean; } export const layerOriginUtils: layerOriginUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Layers Effects json utils for Components. */ interface layersEffectsJsonUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Converts the effect property to its JSON value. * * @param input */ toJSON(input: string | any): any; } export const layersEffectsJsonUtils: layersEffectsJsonUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Background theme utils for Components. */ interface previewSymbol2D { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Determines the contrasting background theme ("light", "dark", or null) for a * given symbol based on color luminance and a threshold. * * @param symbol * @param threshold */ getContrastingBackgroundTheme(symbol: any, threshold?: number): "light" | "dark" | nullish; } export const previewSymbol2D: previewSymbol2D; export class QuantityFormatter { constructor(properties?: any); /** * Note: reserved for internal use only, this is not part of the stable public API. * * Formats an area quantity to a string. * * @param quantity The quantity to format. * @param precision The number of decimal places to include in the formatted string. * @param format The format to use for the quantity. */ formatArea(quantity: Area, precision?: number, format?: UnitFormat): string; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Formats any quantity to a string. * * @param quantity The quantity to format. * @param precision The number of decimal places to include in the formatted string. * @param format The format to use for the quantity. */ formatDecimal(quantity: Length | Area, precision?: number, format?: UnitFormat): string; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Formats a length quantity to a string. * * @param quantity The quantity to format. * @param precision The number of decimal places to include in the formatted string. * @param format The format to use for the quantity. */ formatLength(quantity: Length, precision?: number, format?: UnitFormat): string; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Formats a vertical length quantity (e.g. * * @param quantity The quantity to format. * @param precision The number of decimal places to include in the formatted string. * @param format The format to use for the quantity. */ formatVerticalLength(quantity: Length, precision?: number, format?: UnitFormat): string; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns a promise that resolves when the messages are loaded. */ when(): Promise; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Union of renderers with visual variables. */ export type UnitFormat = "singular" | "plural" | "abbr"; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Utilities for creating a SelectionOperation class instance. */ interface SelectionOperation { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Factory method for creating a SelectionOperation instance. * * @param view The view instance. * @param sources An array of source layers. * @param options Additional tool- and selection-related options for the SelectionOperation. */ createSelectionOperation(view: MapView, sources: any[], options?: SelectionOperationCreateSelectionOperationOptions): any; } export const SelectionOperation: SelectionOperation; export interface SelectionOperationCreateSelectionOperationOptions { createTool?: string; mode?: string; name?: string; persistSelection?: boolean; returnGeometry?: boolean; selectOnComplete?: boolean; type?: string; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Utilites for creating a SketchTooltipControls class instance. */ interface SketchTooltipControls { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Factory method for creating instances of SketchTooltipControls. * * @param visibleElements Determines which elements are visible, such as labels or tooltips. * @param sketchOptions Determines which sketch options to show, such as labels or tooltips. * @param viewType The view type. */ createSketchTooltipControls(visibleElements: SketchTooltipControlsCreateSketchTooltipControlsVisibleElements, sketchOptions: any, viewType?: "2d" | "3d" | nullish): any; } export const SketchTooltipControls: SketchTooltipControls; export interface SketchTooltipControlsCreateSketchTooltipControlsVisibleElements { directionModePicker?: boolean; header?: boolean; labelsToggle?: boolean; tooltipsToggle?: boolean; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Style utils for Components. */ interface styleUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Return the symbol URL for a given style item in the preferred format. * * @param item * @param type */ symbolUrlFromStyleItem(item: any, type: any): string | nullish; } export const styleUtils: styleUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * SVG utils for Components. */ interface svgUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Computes and returns the bounding box that encompasses all given bounding boxes. * * @param bboxes */ computeBBox(bboxes: any[]): any | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Calculates and returns the bounding box for a given shape. * * @param shape */ getBoundingBox(shape: any): any; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Computes and returns a transformation matrix string for a given bounding box, considering scaling, rotation, and other transformations. * * @param bbox * @param width * @param height * @param overallStrokeWidth * @param scale * @param rotation * @param useRotationSize * @param offset * @param bloomSize */ getTransformMatrix(bbox: any, width: number, height: number, overallStrokeWidth: number, scale: boolean, rotation: number | nullish, useRotationSize: boolean, offset?: number[] | null, bloomSize?: number[] | null): string; } export const svgUtils: svgUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * View utils for components. */ interface viewUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Waits until the specified view is not updating anymore. * * @param view */ waitUpdated(view: any): Promise; } export const viewUtils: viewUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Web Style Symbol utils for Components. */ interface webStyleSymbolUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Fetch the symbol from a style by name: * - Find the style item corresponding to the symbol name in the set of items belonging to the style. * * @param styleResponse * @param symbolName * @param context * @param type * @param symbolUrlFromStyleItem * @param options */ fetchSymbolFromStyle(styleResponse: any, symbolName: string, context: any, type: any, symbolUrlFromStyleItem: Function, options?: any | null): Promise; } export const webStyleSymbolUtils: webStyleSymbolUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * VideoView utilities for the Excalibur application. */ interface videoViewUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Creates a new VideoView instance. * * @param properties The properties for the VideoView constructor. */ createVideoView(properties: VideoViewParams): videoViewUtilsVideoView; } export const videoViewUtils: videoViewUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * VideoView. */ export interface videoViewUtilsVideoView { container: HTMLDivElement | nullish; focused: boolean; height: number; layer: VideoLayer | nullish; map: Map | WebMap | nullish; ready: boolean; resizing: boolean; videoSize: number[]; width: number; operationalDataVisible: boolean; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * VideoViewParams. */ export interface VideoViewParams { container: HTMLDivElement; layer: VideoLayer; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Sketch utilities for the experience builder application. */ interface sketchUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Closes the settings popover, if it is open. * * @param sketch Reference to the sketch widget to configure. */ dismissFloatingElements(sketch: Sketch): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Configures the sketch widget's selection appearance. * * @param sketch Reference to the sketch widget to configure. * @param location Selection tool location. */ setContextualToolLocation(sketch: Sketch, location: "inline" | "inline-end" | "separate"): Sketch; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Configures a Sketch widget to display custom tools. * * @param sketch Reference to the sketch widget to configure. * @param createToolOptions Options for the custom tools. * @param customActionOptions Options for the custom tools. */ setCustomTools(sketch: Sketch, createToolOptions?: sketchUtilsSetCustomToolsCreateToolOptions[] | nullish, customActionOptions?: sketchUtilsSetCustomToolsCustomActionOptions[] | nullish): Sketch; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Configures the sketch widget's group collapse behavior. * * @param sketch Reference to the sketch widget to configure. * @param options Group collapse options. */ setGroupAllowCollapse(sketch: Sketch, options: globalThis.Map<"selectionTools" | "selectionSet" | "createTools" | "undoRedo" | "settings", boolean>): Sketch; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Configures the sketch widget's item grouping behavior. * * @param sketch Reference to the sketch widget to configure. * @param priorities Group priorities. */ setGroupCollapsePriorities(sketch: Sketch, priorities: globalThis.Map<"selectionTools" | "selectionSet" | "createTools" | "undoRedo" | "settings", number>): Sketch; } export const sketchUtils: sketchUtils; export interface sketchUtilsSetCustomToolsCreateToolOptions { label: string; icon: string; toolKey: string; toolName: "point" | "polyline" | "polygon" | "rectangle" | "circle"; createOptions?: sketchUtilsSetCustomToolsCreateToolOptionsCreateOptions; } export interface sketchUtilsSetCustomToolsCreateToolOptionsCreateOptions { mode?: "hybrid" | "freehand" | "click"; preserveAspectRatio?: boolean; } export interface sketchUtilsSetCustomToolsCustomActionOptions { id: string; text: string; icon: any; active?: boolean; flipRTL?: boolean; position: "before-selection-set" | "after-selection-set" | "settings-before" | "selection-toolbar"; afterCreate?: any; afterUpdate?: any; afterRemoved?: any; onclick?: any; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Utils for knowledge studio supporting access to utilities shared between Studio and the SDK. */ interface generalSharedKgUtils { extentToInBoundsRings(extent: Extent): number[][][]; getBindParametersFromCypherQuery(query: string): Promise; getDefaultKnowledgeSublayerLabelingInfos(graphTypeName: string, geometryType: "point" | "multipoint" | "polyline" | "polygon" | nullish, displayLabelProperty: string): LabelClass[] | nullish; getDefaultLinkChartSublayerLabelingInfos(graphType: "entity" | "relationship", graphTypeName: string, displayLabelProperty: string): LabelClass[] | nullish; newLinkChartLayerWithOptimizedGeometry(properties?: LinkChartLayerConstructProperties): LinkChartLayer; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns the entity endpoints for the given relationships. * * @param records Relationships to find the endpoints for. * @param kg The knowledge graph service that contains the relationships. * @param options */ studioGetRelationshipEndNodeIds(records: IdTypePair[], kg: KnowledgeGraph, options?: generalSharedKgUtilsStudioGetRelationshipEndNodeIdsOptions): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns a map of origin and destination entities for specific relationships. * * @param records The relationships to retrieve the endpoints for. * @param kg The knowledge graph containing the relationships. * @param options */ studioGetRelationshipEndNodeMap(records: IdTypePair[], kg: KnowledgeGraph, options?: generalSharedKgUtilsStudioGetRelationshipEndNodeMapOptions): Promise>; } export const generalSharedKgUtils: generalSharedKgUtils; export interface BindParamsFromCypherQueryResult { bindParameters: string[]; parseErrors: RecognizerError[] | nullish; } export interface generalSharedKgUtilsStudioGetRelationshipEndNodeIdsOptions { requestOptions?: RequestOptions; } export interface generalSharedKgUtilsStudioGetRelationshipEndNodeMapOptions { requestOptions?: RequestOptions; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer. */ export interface InclusionModeDefinitionOptimizedGeometry { generateAllSublayers: boolean; namedTypeDefinitions: globalThis.Map; } export interface generalSharedKgUtilsLayerInclusionDefinition { useAllData: boolean; members?: globalThis.Map; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Defines the list of `members` for a named type in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-applications-KnowledgeStudio-generalSharedKgUtils.html#inclusionModeDefinition `inclusionModeDefinition`}. */ export interface generalSharedKgUtilsLayerInclusionMemberDefinition { id: string; linkChartLocation?: Point | OptimizedGeometry; } export interface LinkChartLayerConstructProperties { url: string; title?: string; initializationInclusionModeDefinition?: InclusionModeDefinitionOptimizedGeometry; initializationLinkChartConfig?: InitializationLinkChartConfig; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * An alternative geometry format for serialized geometries. */ export interface OptimizedGeometry { lengths: number[]; coords: number[]; } export interface RecognizerError { line: number; column: number; msg: string; e: any; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Utils for knowledge studio supporting access to internal layer properties needed for in-memory state serialization. */ interface layerInternalAccessUtils { addInclusionDefinitionToLayer(layer: KnowledgeGraphLayer, inclusionDefinition: InclusionModeDefinitionOptimizedGeometry): void; getInclusionDefinitionFromLayer(layer: KnowledgeGraphLayer | LinkChartLayer): InclusionModeDefinitionOptimizedGeometry | nullish; readKnowledgeLayerJSON(layer: KnowledgeGraphLayer | LinkChartLayer | KnowledgeGraphSublayer, json: any, originName: "defaults" | "service" | "portal-item" | "web-scene" | "web-map" | "link-chart" | "user"): void; removeInclusionDefinitionFromLayer(layer: KnowledgeGraphLayer): void; } export const layerInternalAccessUtils: layerInternalAccessUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * A utility method for getting a Reshape instance with support for connected reshaping. */ interface reshape { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns a reshape operation. * * @param properties The constructor properties. */ getReshape(properties: ConstructProperties): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Registers a callback to be called when the node movement reshape operation stops. * * @param targetView The LinkChartView in which the node movement reshape operation is taking place. * @param movementStopCallback The callback function to be called when the node movement stops. */ onNodeMovementStop(targetView: LinkChartView, movementStopCallback: MovementStopCallback): IHandle; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Starts a node movement reshape operation in the LinkChartView. * * @param targetEntityId The ID of the entity to be moved. * @param targetEntityType The type of the entity to be moved. * @param targetView The LinkChartView in which the node movement reshape operation will take place. * @param options Optional parameters. */ studioStartNodeMovement(targetEntityId: string, targetEntityType: string, targetView: LinkChartView, options?: any): Promise; } export const reshape: reshape; export type CancelNodeMovement = () => void; export type CommitNodeMovement = () => Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * An object that provides "connected reshaping" functionality for a feature or vertex being reshaped. */ export interface ConnectedReshapeProvider { updating: boolean; translate: Translate; } export interface ConnectedReshapeProviderFactory { getFeatureReshapeProvider: GetFeatureReshapeProvider; getVertexReshapeProvider: GetVertexReshapeProvider; } export interface ConstructProperties { connectedReshapeProviders: ConnectedReshapeProviderFactory[] | nullish; graphic: Graphic; layer: GraphicsLayer; view: MapView; } export type Destroy = () => void; export type GetFeatureReshapeProvider = (features: ReshapeFeature[]) => ConnectedReshapeProvider | nullish; export type GetVertexReshapeProvider = ( feature: ReshapeFeature, vertices: VertexInfo[], ) => ConnectedReshapeProvider | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Represents a feature that has been modified by a ConnectedReshapeProvider due to being connected (or otherwise spatially related to) the feature(s) or vertex(es) being reshaped. */ export interface ModifiedFeature { graphic: Graphic; layer: | GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | GraphicsLayer | KnowledgeGraphSublayer; originalGraphic: Graphic; uniqueId: string | number; } export type MovementStopCallback = (event: MovementStopCallbackEvent) => void; export interface Reshape { connectedReshapeProviders: ConnectedReshapeProviderFactory[] | nullish; graphic: Graphic; layer: GraphicsLayer; view: MapView; destroy: Destroy; } export interface ReshapeFeature { graphic: Graphic; layer: | GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | GraphicsLayer | KnowledgeGraphSublayer | nullish; } export interface StudioNodeMovementReturnType { commitNodeMovement: CommitNodeMovement; cancelNodeMovement: CancelNodeMovement; } export type StudioStartNodeMovementOptions = () => void; export type Translate = (deltaX: number, deltaY: number, deltaZ: number | nullish) => ModifiedFeature[]; export interface VertexInfo { pathIndex: number; vertexIndex: number; } export interface MovementStopCallbackEvent { mover: Graphic; dx: number; dy: number; } interface resourceSerializationUtils { fetchAndConvertSerializedKnowledgeIdMap(idCollectionsUrl: string, generateAllSublayers?: boolean): Promise; fetchAndConvertSerializedLinkChart(serializedResourceURLs: SerializedResourceURLs): Promise; serializeInclusionDefinitionToAllPbf(inclusionDefinition: InclusionModeDefinitionOptimizedGeometry, kg: KnowledgeGraph, endpointMap: globalThis.Map): Promise; serializeInclusionDefinitionToIdCollectionsMapPbf(inclusionDefinition: InclusionModeDefinitionOptimizedGeometry): Promise; } export const resourceSerializationUtils: resourceSerializationUtils; export interface SerializedFeatureCollections { entitiesFC: ArrayBuffer; relationshipsFC: ArrayBuffer; } export interface SerializedResourceURLs { entitiesUrl?: string; relationshipsUrl?: string; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * General layer utilities for the map viewer application. */ interface layerUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Returns `true` if the layer url has been modified from its initial value to use the preferred host * advertised in its metadata via `preferredHost` property. * * @param layer The layer to check. */ isUrlHostModified(layer: any): boolean; } export const layerUtils: layerUtils; /** * 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. * * @param mediaElement The media element to create the georeference for. * @param extent The view extent in which fits the georeference. */ 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. * * @param mediaElement The media element to create the georeference for. */ createLocalModeControlPointsGeoreference(mediaElement: ImageElement | VideoElement): ControlPointsGeoreference | nullish; } export const mediaUtils: mediaUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Table template utilities for the map viewer application. */ interface templateUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Generates an AttributeTableTemplate based on the default layer fields. * * @param options Method parameters. */ createDefaultAttributeTableTemplateFromLayer(options: templateUtilsCreateDefaultAttributeTableTemplateFromLayerOptions): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Generates a TableTemplate based on the default layer fields. * * @param options Method parameters. */ createDefaultTableTemplateFromLayer(options: templateUtilsCreateDefaultTableTemplateFromLayerOptions): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Generates a TableTemplate based on a pre-existing AttributeTableTemplate. * * @param options Method parameters. */ createTableTemplateFromAttributeTableTemplate(options: templateUtilsCreateTableTemplateFromAttributeTableTemplateOptions): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Syncs a provided AttributeTableTemplate with the current state of a provided FeatureTable, using the 'columns' Collection on FeatureTable specifically. * * @param table Table widget used to update the template. * @param template Template to update with the provided table. * @param includeHiddenColumns Indicates hidden columns should be included in orderByFields (defaults to true). */ syncAttributeTableTemplate(table: FeatureTable, template: AttributeTableTemplate, includeHiddenColumns?: boolean): AttributeTableTemplate; } export const templateUtils: templateUtils; export interface templateUtilsCreateDefaultAttributeTableTemplateFromLayerOptions { layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer; excludeAttachments?: boolean; excludeRelationships?: boolean; excludedFieldTypesOverride?: any[]; } export interface templateUtilsCreateDefaultTableTemplateFromLayerOptions { layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer; excludeAttachments?: boolean; excludeRelationships?: boolean; excludedFieldTypesOverride?: any[]; } export interface templateUtilsCreateTableTemplateFromAttributeTableTemplateOptions { layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer; template: AttributeTableTemplate; includeHiddenFields?: boolean; excludedFieldTypesOverride?: any[]; } /** * 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. * * @param color Color */ 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. * * Adjusts the "doc.geoscene.cn/resources" part of an URL to point to the * corresponding development hostname. * * @param url * @param hostname the window location hostname, automatically determined if not provided */ adjustStaticAGOUrl(url?: string | null, hostname?: string): string | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Check if we are running in a dev environment. * * @param hostname the window location hostname, automatically determined if not provided */ 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. * * @param hostname the window location hostname, automatically determined if not provided */ isTelemetryDevEnvironment(hostname: string): boolean; } export const devEnvironmentUtils: devEnvironmentUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Various layer utilities for the Scene Viewer application. */ interface SceneViewerLayerUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Get the origin of a property in the store. * * @param layer layer. * @param property layer property to revert. */ originOfLayerProperty(layer: OperationalLayer, property: string): "defaults" | "service" | "portal-item" | "web-scene" | "web-map" | "link-chart" | "user" | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Reverts the value of a property to the value that was read * from a specific origin. * * @param layer layer. * @param property layer property to revert. * @param origin to revert to. */ revertLayerProperty(layer: OperationalLayer, property: string, origin: "service" | "portal-item" | "web-scene" | "web-map" | "link-chart"): void; } export const SceneViewerLayerUtils: SceneViewerLayerUtils; /** * 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. * * @param webscene The webscene to be checked. */ canSaveAs(webscene: WebScene): boolean; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Helper function to close a catalog layer in the layer list. * * @param layerList */ closeCatalogLayer(layerList: LayerList): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Create a new TilingScheme based on the tileInfo. * * @param tileInfo tileInfo to create TilingScheme */ 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. * * @param viewModel view model. */ 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. * * @param viewModel view model. */ editorNavigateBack(viewModel: EditorViewModel): Promise; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Helper function to retrieve a popup feature from a LayerView or the underlying FeatureLayer. * * @param layerView * @param graphics */ fetchPopupFeaturesFromGraphics(layerView: LayerView | BuildingComponentSublayerView, graphics: Graphic[]): 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). * * @param tileInfo input tileInfo to be compatible with * @param expectedTileSize the expected tile size. */ getCompatibleTileInfoForVTL(tileInfo: TileInfo, expectedTileSize: number): any | nullish; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Helper function to retrieve the source layer of a graphic with source layer of type BuildingComponentSubLayer. * * @param graphic */ getSourceLayerFromBuildingComponentSublayerGraphic(graphic: Graphic): BuildingComponentSublayer | nullish; /** * 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. * * @param saveError error thrown during webscene serialization. */ isSchemaValidationError(saveError: Error): 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. * * @param spatialReference The spatial reference to check. * @param viewingMode The viewing mode to check. */ 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. * * @param tileInfo tileInfo to check */ 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. * * @param swatch the svg elements to renders * @param width width * @param height height * @param options additional options */ 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. * * @param warningMessage A warning message for the end user. * @param error The returned error message. */ saveStateWarning(warningMessage: string, error: any): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Allows setting overrides for the `defaultsFromMap` used by a view. * * @param view * @param settings */ setDefaultsFromMapSettings(view: SceneView, settings: DefaultsFromMapSettings): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Helper function to set the source layer of a graphic using a layer of type BuildingComponentSubLayer. * * @param graphic * @param sourceLayer */ setSourceLayerOfBuildingComponentSublayerGraphic(graphic: Graphic, sourceLayer: BuildingComponentSublayer): 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. * * @param view */ zoomDragBeginPoint(view: SceneView): number[] | nullish; } export const sceneViewerUtils: sceneViewerUtils; export interface DefaultsFromMapRequiredComponents { tileInfo: boolean; heightModelInfo: boolean; extent: boolean; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Settings to be used for the `defaultsFromMap` of a view. */ export interface DefaultsFromMapSettings { defaultSpatialReference?: SpatialReference; isSpatialReferenceSupported?: IsSpatialReferenceSupportedCallback; priorityLayers?: Layer[]; required?: DefaultsFromMapRequiredComponents; } export type IsSpatialReferenceSupportedCallback = (spatialReference: SpatialReference, layer?: Layer) => boolean; /** * 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. * * @param symbolLayer the symbol layer. */ computeObjectLayerSize(symbolLayer: ObjectSymbol3DLayer): Promise; } export const SceneViewerSymbolUtils: SceneViewerSymbolUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Mesh utilities for the Urban application. */ interface UrbanMeshUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Converts a mesh to a new vertex space. * * @param mesh the mesh geometry to convert. * @param targetVertexSpace the vertex space to convert to. * @param options Additional options. */ convertVertexSpaceEllipsoid(mesh: Mesh, targetVertexSpace: MeshGeoreferencedVertexSpace | MeshLocalVertexSpace, options?: meshUtilsConvertVertexSpaceEllipsoidOptions): Promise; } export const UrbanMeshUtils: UrbanMeshUtils; export interface meshUtilsConvertVertexSpaceEllipsoidOptions { signal?: AbortSignal | nullish; } /** * Note: reserved for internal use only, this is not part of the stable public API. * * Sketch utilities for the WebEditor application. */ interface WebEditorSketchUtils { /** * Note: reserved for internal use only, this is not part of the stable public API. * * Hides all the tooltip visible elements. * * @param sketchViewModel The sketch view model. */ hideAllVisibleElements(sketchViewModel: SketchViewModel): void; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Shows a tooltip and focuses on a specific field. * * @param sketchViewModel The sketch view model. * @param fieldName The name of the field to focus on in the tooltip. * @param options Options used to show the tooltip. */ showTooltipAndFocusField(sketchViewModel: SketchViewModel, fieldName: | "area" | "distance" | "direction" | "elevation" | "orientation" | "radius" | "rotation" | "scale" | "size" | "totalLength" | "coordinates", options?: ShowTooltipAndFocusFieldOptions): Promise; } export const WebEditorSketchUtils: WebEditorSketchUtils; /** * Note: reserved for internal use only, this is not part of the stable public API. * * Options used to show the tooltip. */ export interface ShowTooltipAndFocusFieldOptions { signal?: AbortSignal | nullish; position?: [number, number]; hideOnBlur?: boolean; /** * Callback function that is called when the tooltip is opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-applications-WebEditor-sketchUtils.html#ShowTooltipAndFocusFieldOptions Read more...} */ onOpen(): void; /** * Callback function that is called when the tooltip is closed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-applications-WebEditor-sketchUtils.html#ShowTooltipAndFocusFieldOptions Read more...} */ onClose(): void; } /** * This module allows you to evaluate {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade expressions} outside * traditional GeoScene Arcade {@link https://doc.geoscene.cn/javascript/4.33/arcade/#where-can-i-use-arcade profiles}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html Read more...} */ interface arcade { /** * Compiles an Arcade expression and its profile into an executor. * * @param script The {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade expression} to compile and execute. * @param profile The profile definition used to execute the given expression. The profile defines the profile variable names and data types the user may use as inputs in the expression. The variable instances are provided to the executor function. * @param options _Since 4.33_ Options used to configure the executor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#createArcadeExecutor Read more...} */ createArcadeExecutor(script: string, profile: Profile, options?: arcadeCreateArcadeExecutorOptions): Promise; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#Profile Profile} definition for an Arcade profile implemented in the GeoScene Maps SDK for JavaScript. * * @param profileName The name of the Arcade profile definition to create. _The values `"feature-reduction-popup"` and `"feature-reduction-popup-element"` are deprecated since 4.32._ * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#createArcadeProfile Read more...} */ createArcadeProfile(profileName: | "aggregate-field" | "form-constraint" | "feature-z" | "field-calculation" | "form-calculation" | "labeling" | "popup" | "popup-element" | "popup-feature-reduction" | "popup-element-feature-reduction" | "visualization" | "popup-voxel" | "popup-element-voxel" | "feature-reduction-popup" | "feature-reduction-popup-element"): Profile; } export const arcade: arcade; export interface arcadeCreateArcadeExecutorOptions { lruCache?: any; services?: ArcadeServices; } /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ArcadeExecutor Read more...} */ export interface ArcadeExecutor { execute: ExecuteFunction; executeAsync: ExecuteFunctionAsync; executeAsyncBatch: ExecuteFunctionAsyncBatch; fieldsUsed: string[]; geometryUsed: boolean; isAsync: boolean; } /** * ArcadeServices provides access to services and user information that are required for executing Arcade expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ArcadeServices Read more...} */ export interface ArcadeServices { portal?: Portal; } /** * The type definition of a profile variable of type `array`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ArrayElementType Read more...} */ export interface ArrayElementType { type: | "array" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "number" | "text" | "date" | "dateOnly" | "time" | "boolean" | "knowledgeGraph" | "voxel"; properties?: ProfileVariable[]; elementType?: ArrayElementType; } /** * The type definition for an Arcade array profile variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ArrayVariable Read more...} */ export interface ArrayVariable { name: string; type: "array"; elementType?: ArrayElementType; } /** * The context of the Arcade expression for batch execution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#BatchExecuteContext Read more...} */ export interface BatchExecuteContext { spatialReference?: SpatialReference; timeZone?: string; maxConcurrency?: number; } /** * The type definition for an Arcade dictionary profile variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#DictionaryVariable Read more...} */ export interface DictionaryVariable { name: string; type: "dictionary"; properties?: ProfileVariable[]; } /** * The execution context of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ExecuteContext Read more...} */ export interface ExecuteContext { spatialReference?: SpatialReference; timeZone?: string; lruCache?: any; services?: ArcadeServices; } export type ExecuteFunction = (profileVariableInstances: any, context?: ExecuteContext) => ResultType; export type ExecuteFunctionAsync = (profileVariableInstances: any, context?: ExecuteContext) => Promise; export type ExecuteFunctionAsyncBatch = ( inputData: Iterable, variableInstancesCreator: VariableInstancesCreator, context?: BatchExecuteContext, ) => Promise; /** * Layer types that may be used to back FeatureSets in Arcade expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#FeatureSetLayer Read more...} */ export type FeatureSetLayer = | FeatureLayer | CSVLayer | GeoJSONLayer | WFSLayer | OrientedImageryLayer | SubtypeGroupLayer | CatalogLayer | SubtypeSublayer | CatalogFootprintLayer | KnowledgeGraphSublayer; /** * Type definition for a fulfilled promise of the asynchronous execution of an Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#FulfilledArcadePromise Read more...} */ export interface FulfilledArcadePromise { status: "fulfilled"; value: ResultType; } /** * Defines the definitions of a profile's input variables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#Profile Read more...} */ export interface Profile { variables: ProfileVariable[]; } /** * The type definition of a profile variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ProfileVariable Read more...} */ export type ProfileVariable = SimpleVariable | DictionaryVariable | ArrayVariable; /** * The JavaScript types that may be used as inputs to profile variables when evaluating compiled expressions * with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ExecuteFunction ExecuteFunction} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ExecuteFunctionAsync ExecuteFunctionAsync}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ProfileVariableInstanceType Read more...} */ export type ProfileVariableInstanceType = | Graphic | GeometryUnion | FeatureSet | FeatureSetLayer | Map | KnowledgeGraph | string | number | boolean | Date | any | any[]; /** * Type definition for a rejected promise of the asynchronous execution of an Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#RejectedArcadePromise Read more...} */ export interface RejectedArcadePromise { status: "rejected"; reason: any; } /** * The JavaScript type of the result returned from the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#ResultType Read more...} */ export type ResultType = number | string | Date | boolean | Graphic | GeometryUnion | any | ResultType[]; /** * Type definition for a settled promise of the asynchronous execution of an Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#SettledArcadePromise Read more...} */ export type SettledArcadePromise = FulfilledArcadePromise | RejectedArcadePromise; /** * The type definition for a simple Arcade profile variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-arcade.html#SimpleVariable Read more...} */ export interface SimpleVariable { name: string; type: | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "number" | "text" | "date" | "dateOnly" | "time" | "boolean" | "knowledgeGraph" | "voxel"; } export type VariableInstancesCreator = (inputData: any) => any; export interface AttributeBinsGraphic extends Graphic, JSONSupport, Clonable { } export class AttributeBinsGraphic { /** * The stackedAttributes contains an array of name-value pairs, where the names correspond to unique values of the specified field or expression alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html#stackedAttributes Read more...} */ stackedAttributes: HashMap[] | nullish; /** * A Graphic returned in a FeatureSet as result of running `queryAttributeBins()` method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html Read more...} */ constructor(properties?: AttributeBinsGraphicProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeBinsGraphic; } interface AttributeBinsGraphicProperties extends GraphicProperties { /** * The stackedAttributes contains an array of name-value pairs, where the names correspond to unique values of the specified field or expression alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html#stackedAttributes Read more...} */ stackedAttributes?: HashMap[] | nullish; } export interface Basemap extends Accessor, Loadable, JSONSupport { } export class Basemap { /** * An identifier used to refer to the basemap when referencing it elsewhere. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#id Read more...} */ id: string | nullish; /** * Indicates whether the basemap instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The URL pointing to an image that represents the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#thumbnailUrl Read more...} */ thumbnailUrl: string | nullish; /** * The title of the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#title Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Read more...} */ constructor(properties?: BasemapProperties); /** * A collection of tile layers that make up the basemap's features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers Read more...} */ get baseLayers(): Collection; set baseLayers(value: CollectionProperties); /** * The portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A collection of reference layers which are displayed over the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers base layers} and all other layers in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#referenceLayers Read more...} */ get referenceLayers(): Collection; set referenceLayers(value: CollectionProperties); /** * The spatial reference of the Basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The style of the basemap from the [basemap styles service (v2)](https://doc.geoscene.cn/rest/basemap-styles/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#style Read more...} */ get style(): BasemapStyle | nullish; set style(value: BasemapStyleProperties | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#clone Read more...} */ clone(): Basemap; /** * Destroys the basemap, and any associated resources, including its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#layers layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#portalItem portalItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#destroy Read more...} */ destroy(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Loads all the externally loadable resources associated with the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#loadAll Read more...} */ loadAll(): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#toJSON Read more...} */ toJSON(): any; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new basemap instance from a [basemap id](geoscene-Map.html#basemap-id). * * @param id The basemap id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#fromId Read more...} */ static fromId(id: string): Basemap | nullish; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Basemap; } interface BasemapProperties extends LoadableProperties { /** * A collection of tile layers that make up the basemap's features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers Read more...} */ baseLayers?: CollectionProperties; /** * An identifier used to refer to the basemap when referencing it elsewhere. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#id Read more...} */ id?: string | nullish; /** * The portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A collection of reference layers which are displayed over the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers base layers} and all other layers in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#referenceLayers Read more...} */ referenceLayers?: CollectionProperties; /** * The spatial reference of the Basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The style of the basemap from the [basemap styles service (v2)](https://doc.geoscene.cn/rest/basemap-styles/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#style Read more...} */ style?: BasemapStyleProperties | nullish; /** * The URL pointing to an image that represents the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#thumbnailUrl Read more...} */ thumbnailUrl?: string | nullish; /** * The title of the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#title Read more...} */ title?: string; } export interface Camera extends Accessor, JSONSupport, Clonable { } export class Camera { /** * The diagonal field of view (fov) angle for the camera. * * @default 55 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#fov Read more...} */ fov: number; /** * The compass heading of the camera in degrees. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading Read more...} */ heading: number; /** * The tilt of the camera in degrees with respect to the surface as projected * down from the camera position. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#tilt Read more...} */ tilt: number; /** * The camera defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#position position}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#tilt tilt}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading heading} * of the point from which the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView's} visible extent * is observed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html Read more...} */ constructor(properties?: CameraProperties); /** * The layout defines which sub-region of the camera is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#layout Read more...} */ get layout(): CameraLayout; set layout(value: CameraLayoutProperties); /** * The position of the camera defined by a map point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#position Read more...} */ get position(): Point; set position(value: PointProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Camera; } interface CameraProperties { /** * The diagonal field of view (fov) angle for the camera. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#fov Read more...} */ fov?: number; /** * The compass heading of the camera in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading Read more...} */ heading?: number; /** * The layout defines which sub-region of the camera is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#layout Read more...} */ layout?: CameraLayoutProperties; /** * The position of the camera defined by a map point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#position Read more...} */ position?: PointProperties; /** * The tilt of the camera in degrees with respect to the surface as projected * down from the camera position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#tilt Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#column Read more...} */ column: number; /** * The number of columns to decompose the camera in a tiled display setup. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#columns Read more...} */ columns: number; /** * The active row a display client renders to in a tiled display setup. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#row Read more...} */ row: number; /** * The number of rows to decompose the camera in a tiled display setup. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#rows Read more...} */ rows: number; /** * The camera layout defines the position of the current view in a distributed larger view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html Read more...} */ constructor(properties?: CameraLayoutProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#clone Read more...} */ clone(): this; } interface CameraLayoutProperties { /** * The active column a display client renders to in a tiled display setup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#column Read more...} */ column?: number; /** * The number of columns to decompose the camera in a tiled display setup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#columns Read more...} */ columns?: number; /** * The active row a display client renders to in a tiled display setup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#row Read more...} */ row?: number; /** * The number of rows to decompose the camera in a tiled display setup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-CameraLayout.html#rows Read more...} */ rows?: number; } export class Color { /** * The alpha value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#a Read more...} */ a: number; /** * The blue value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#b Read more...} */ b: number; /** * The green value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#g Read more...} */ g: number; /** * The red value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#r Read more...} */ r: number; constructor(color: string | number[] | RGBA); /** * Creates a deep clone of the Color instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#clone Read more...} */ clone(): Color; /** * Checks equality of the Color instance with another Color instance. * * @param other Another color, or null or undefined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#equals Read more...} */ equals(other: Color | nullish): boolean; /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} object * and sets this color instance to the input value. * * @param color The new color value. This parameter can be a string representing a named color or a hex value; an array of three or four numbers representing r, g, b, a values; or an object with r, g, b, a properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#setColor Read more...} */ setColor(color: string | number[] | any): Color; /** * Returns a CSS color string in rgba form representing the Color instance. * * @param includeAlpha If `true`, the alpha value will be included in the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#toCss Read more...} */ toCss(includeAlpha?: boolean): string; /** * Returns the color in hexadecimal format. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#toHex Read more...} */ toHex(options?: ColorToHexOptions): string; /** * Returns a JSON object with all the values from a Color instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#toJSON Read more...} */ toJSON(): any; /** * Returns a 3-component array of rgb values that represent the Color instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#toRgb Read more...} */ toRgb(): number[]; /** * Returns a 4-component array of rgba values that represent the Color instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#toRgba Read more...} */ toRgba(): number[]; /** * Creates a Color instance by blending two colors using a weight factor. * * @param start The start color. * @param end The end color. * @param weight The weight value is a number from 0 to 1, with 0.5 being a 50/50 blend. * @param out A previously allocated Color object to reuse for the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#blendColors Read more...} */ 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. * * @param a The input array. * @param t A previously allocated Color object to reuse for the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#fromArray Read more...} */ static fromArray(a: number[], t?: Color): Color; /** * Creates a Color from hexadecimal string. * * @param hex The input color in a hexadecimal string. * @param out A previously allocated Color object to reuse for the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#fromHex Read more...} */ static fromHex(hex: string, out?: Color): Color | nullish; /** * Creates a new Color instance, and initializes it with values from a JSON object. * * @param json A JSON representation of the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#fromJSON Read more...} */ static fromJSON(json: any | nullish): Color | nullish; /** * Creates a Color instance from a string of the form "rgb()" or "rgba()". * * @param color The input color in a string of the form "rgb()" or "rgba()". * @param out A previously allocated Color object to reuse for the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#fromRgb Read more...} */ static fromRgb(color: string, out?: Color): Color | nullish; /** * Creates a Color instance by parsing a generic string. * * @param color The input value. * @param obj A previously allocated Color object to reuse for the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html#fromString Read more...} */ static fromString(color: string, obj?: Color): Color | nullish; } export interface ColorToHexOptions { capitalize?: boolean; digits?: number; } export interface RGBA { r?: number; g?: number; b?: number; a?: number; } /** * Configure global properties of the library. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html Read more...} */ interface config { apiKey: string | nullish; apiKeys: configApiKeys; applicationName: string; assetsPath: string; fontsUrl: string; geometryServiceUrl: string; geoRSSServiceUrl: string; kmlServiceUrl: string; log: configLog; portalUrl: string; request: configRequest; respectPrefersReducedMotion: boolean; routeServiceUrl: string; userPrivilegesApplied: boolean; workers: configWorkers; } export const config: config; export type AfterInterceptorCallback = (response: RequestResponse) => void; export type BeforeInterceptorCallback = (params: BeforeInterceptorCallbackParams) => any; export interface configApiKeys { basemapStyles?: string; scopes?: configApiKeysScopes[]; } export interface configApiKeysScopes { token: string; urls: RegExp | string | (RegExp | string)[]; } export interface configLog { interceptors: LogInterceptor[]; level: "none" | "error" | "info" | "warn" | nullish; } export interface configRequest { httpsDomains?: string[]; interceptors?: RequestInterceptor[]; maxUrlLength?: number; priority?: "auto" | "high" | "low"; proxyRules?: configRequestProxyRules[]; proxyUrl: string | nullish; timeout: number; trustedServers: string[]; useIdentity: boolean; } export interface configRequestProxyRules { proxyUrl: string; urlPrefix: string; } export interface configWorkers { loaderUrl?: string; workerPath?: string; loaderConfig?: configWorkersLoaderConfig; } export interface configWorkersLoaderConfig { baseUrl?: string; has?: any; paths?: any; map?: any; packages?: any[]; } export type ErrorCallback = (error: Error) => void; export type LogInterceptor = (level: "none" | "error" | "info" | "warn", module: string, ...args: any[]) => boolean; /** * Specifies the object used for intercepting and modifying requests made via {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html geosceneRequest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#RequestInterceptor Read more...} */ export interface RequestInterceptor { after?: AfterInterceptorCallback; before?: BeforeInterceptorCallback; error?: ErrorCallback; headers?: any; query?: any; responseData?: any; urls?: string | RegExp | (string | RegExp)[]; } export interface BeforeInterceptorCallbackParams { url: string; requestOptions: RequestOptions; } export type WatchCallback = (newValue: any, oldValue: any, propertyName: string, target: Accessor) => void; /** * Represents a watch or event handler which can be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Accessor.html#WatchHandle Read more...} */ export interface WatchHandle { /** * Removes the watch handle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Accessor.html#WatchHandle Read more...} */ remove(): void; } /** * This module contains Accessor [TypeScript](https://www.typescriptlang.org/docs/handbook/decorators.html) * decorators. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html Read more...} */ 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. * * @param propertyName The aliased property name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html#aliasOf Read more...} */ aliasOf(propertyName: string): Function; /** * This method decorator is used to define the method that will cast a property from a class. * * @param propertyName The property name the function will cast. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html#cast Read more...} */ cast(propertyName: string): Function; /** * This property decorator is used to define the function or class for a property. * * @param functionOrClass The function or class to cast the property * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html#cast Read more...} */ cast(functionOrClass: Function): Function; /** * This convenience decorator is used to define an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Accessor.html Accessor} property. * * @param metadata An object describing the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html#property Read more...} */ property(metadata?: decoratorsPropertyMetadata): Function; /** * This decorator is used to define an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Accessor.html Accessor} subclass. * * @param declaredClass The subclass name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-accessorSupport-decorators.html#subclass Read more...} */ subclass(declaredClass?: string): Function; } export const decorators: decorators; export type Caster = (value: any) => any; export interface decoratorsPropertyMetadata { dependsOn?: string[]; type?: any; cast?: Caster | nullish; readOnly?: boolean; constructOnly?: boolean; aliasOf?: string; value?: any; } export class Clonable { /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Clonable.html#clone Read more...} */ clone(): this; } export interface CollectionAfterAddEvent { item: any; } export interface CollectionAfterChangesEvent { } export interface CollectionAfterRemoveEvent { item: any; } export interface CollectionBeforeAddEvent { cancellable: boolean; defaultPrevented: boolean; item: any; /** * A method that prevents the item from being added * to the collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html#event-before-add Read more...} */ preventDefault(): void; } export interface CollectionBeforeChangesEvent { cancellable: boolean; defaultPrevented: boolean; item: any; /** * A method that prevents the item from being added * or removed from the collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html#event-before-changes Read more...} */ preventDefault(): void; } export interface CollectionBeforeRemoveEvent { cancellable: boolean; defaultPrevented: boolean; item: any; /** * A method that prevents the item from being removed * from the collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html#event-before-remove Read more...} */ preventDefault(): void; } export class Error { /** * The details object provides additional details specific to the error, * giving more information about why the error was raised. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html#details Read more...} */ details: any | nullish; /** * A message describing the details of the error. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html#message Read more...} */ message: string; /** * A unique error name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html#name Read more...} */ name: string; constructor(name: string, message: string, details?: any); } export class Evented { /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Evented.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Evented.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Evented.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Evented.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; } export type EventHandler = (event: any) => void; export class Handles { constructor(); /** * Adds a group of handles. * * @param handles An array or collection handles to group. * @param groupKey Key identifying the group to which the handles should be added. All the handles in the group can later be removed with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#remove Handles.remove()}. If no key is provided the handles are added to a default group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#add Read more...} */ add(handles: WatchHandle | WatchHandle[] | Collection, groupKey?: any): void; /** * Destroys the object, removing all the handles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#destroy Read more...} */ destroy(): void; /** * Returns true if a group exists for the provided group key, false otherwise. * * @param groupKey group handle key * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#has Read more...} */ has(groupKey: any): boolean; /** * Removes a group of handles. * * @param groupKey A group key or an array or collection of group keys to remove. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#remove Read more...} */ remove(groupKey?: any): void; /** * Removes all handles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#removeAll Read more...} */ removeAll(): void; } /** * A handle to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#highlight highlight} call result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#Handle Read more...} */ export interface Handle { /** * Removes the handle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Handles.html#Handle Read more...} */ remove(): void; } export class Identifiable { readonly uid: string; } interface IdentifiableProperties { } export class JSONSupport { /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-JSONSupport.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-JSONSupport.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; } /** * Provides a utility method for deeply cloning objects with properties that are computed or have their own `clone()` method, such as * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-lang.html Read more...} */ interface lang { /** * Use this method to deeply clone objects with properties that are computed or have their own `clone()` method. * * @param elem The object to be cloned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-lang.html#clone Read more...} */ clone(elem: any): any; } export const lang: lang; export class Loadable { readonly loadError: Error | nullish; readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; readonly loadWarnings: any[]; /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#cancelLoad Read more...} */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Loadable.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface LoadableProperties { } export interface LoadableLoadOptions { signal?: AbortSignal | nullish; } export class corePromise { /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Promise.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Promise.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Promise.html#isResolved Read more...} */ isResolved(): boolean; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Promise.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } /** * Various utilities and convenience functions for working with promises. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html Read more...} */ interface promiseUtils { /** * Creates a special error object which is used to signal aborted requests in promise chains. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#createAbortError Read more...} */ createAbortError(): Error; /** * A utility for ensuring an input function is not simultaneously invoked more than once at a time. * * @param callback A function to prevent executing during the execution of a previous call to the same function. This is typically a function that may be called on mouse-move or mouse-drag events. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#debounce Read more...} */ debounce(callback: T): T; /** * Convenience utility method to wait for a number of promises to either resolve or * reject. * * @param promises Array of promises, or object where each property is a promise. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#eachAlways Read more...} */ eachAlways(promises: Promise[] | any): Promise | any; /** * A convenience utility method for filtering an array of values using an asynchronous predicate function. * * @param input The array of input values to filter. * @param predicate A predicate function returning a promise. Only array entries for which the returned promise contains `true` are kept. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#filter Read more...} */ filter(input: T[], predicate: FilterPredicateCallback): Promise; /** * Catches and "drops" abort errors. * * @param promise The promise to catch abort errors on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#ignoreAbortErrors Read more...} */ ignoreAbortErrors(promise: Promise): void; /** * Check if the provided error object is the special kind of error with which promises are rejected when they are * aborted. * * @param error The error object to test. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#isAbortError Read more...} */ isAbortError(error: Error): boolean; } export const promiseUtils: promiseUtils; /** * The result object for a promise passed to promiseUtils.eachAlways. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-promiseUtils.html#EachAlwaysResult Read more...} */ export interface EachAlwaysResult { promise: Promise; value?: any; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-quantity.html Read more...} */ namespace quantity { export interface Length { value: number; unit: LengthUnit; type: "length"; } export interface Area { value: number; unit: AreaUnit; type: "area"; } export interface Angle { value: number; unit: AngleUnit; type: "angle"; } } export interface Angle { value: number; unit: AngleUnit; type: "angle"; } export interface Area { value: number; unit: AreaUnit; type: "area"; } export interface Length { value: number; unit: LengthUnit; type: "length"; } /** * Various utilities and convenience functions for executing code at various phases of browser frames. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html Read more...} */ interface scheduling { /** * Registers a frame task. * * @param phases The callbacks for each phase of the frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#addFrameTask Read more...} */ addFrameTask(phases: PhaseCallbacks): FrameTaskHandle; /** * Schedules the execution of a `callback` function at the next web browser tick. * * @param callback The function to call at the next tick. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#schedule Read more...} */ schedule(callback: Function): any; } export const scheduling: scheduling; /** * An object to remove or pause a frame task registered with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#addFrameTask addFrameTask()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#FrameTaskHandle Read more...} */ export interface FrameTaskHandle { /** * Pause the execution the frame task at every frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#FrameTaskHandle Read more...} */ pause(): void; /** * Resumes the execution the frame task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#FrameTaskHandle Read more...} */ resume(): void; /** * Removes the frame task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#FrameTaskHandle Read more...} */ remove(): void; } export type PhaseCallback = (event?: PhaseEvent) => void; /** * A set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#PhaseCallback callbacks} that will be called at * specific phases of the animation frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#PhaseCallbacks Read more...} */ export interface PhaseCallbacks { prepare?: PhaseCallback; render?: PhaseCallback; update?: PhaseCallback; } /** * An object with timing information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-scheduling.html#PhaseEvent Read more...} */ export interface PhaseEvent { time: number; deltaTime: number; elapsedFrameTime: number; } /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html WhereClause} expression that adheres to standardized SQL expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql.html Read more...} */ interface sql { /** * Parses the given where clause string and returns an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html WhereClause} when resolved. * * @param clause The SQL where clause expression. * @param fieldsIndex The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fieldsIndex fields index} of the layer. The fields index is used to match the fields found in the where clause against the service, to fix casing for example. * @param timeZone The time zone in which SQL date functions are evaluated. The default is "UTC". This parameter only accepts {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones IANA time zones}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql.html#parseWhereClause Read more...} */ parseWhereClause(clause: string, fieldsIndex: FieldsIndex | nullish, 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html Read more...} */ interface WhereClause { fieldNames: string[]; readonly isStandardized: boolean; parseTree: SQLNode; /** * Executes the where clause against a feature to generate a value. * * @param feature The feature to check against the where clause. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#calculateValue Read more...} */ calculateValue(feature: any): any; /** * Tests the attributes of a feature against the `whereClause`, and returns `true` if the test passes, `false` otherwise. * * @param feature The feature to test against the `whereClause`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#testFeature Read more...} */ testFeature(feature: any): boolean; } export const WhereClause: WhereClause; /** * A binary expression node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#BinaryNode Read more...} */ export interface BinaryNode { type: "binary-expression"; location: SQLSourceLocation; operator: | "AND" | "OR" | "IS" | "ISNOT" | "IN" | "NOT IN" | "BETWEEN" | "NOTBETWEEN" | "LIKE" | "NOT LIKE" | "<>" | "<" | ">" | ">=" | "<=" | "=" | "*" | "-" | "+" | "/" | "||"; left: SQLNode; right: SQLNode; escape?: string; } /** * A node that contains a boolean expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#BoolNode Read more...} */ export interface BoolNode { type: "boolean"; location: SQLSourceLocation; value: boolean; } /** * A node that contains column name of a layer or table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#ColumnNode Read more...} */ export interface ColumnNode { type: "column-reference"; location: SQLSourceLocation; column: string; } /** * A node that contains `CURRENT_TIMESTAMP`, `CURRENT_TIME`, or `CURRENT_DATE` functions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#CurrentTimeNode Read more...} */ export interface CurrentTimeNode { type: "current-time"; location: SQLSourceLocation; mode: "timestamp" | "date" | "time"; } /** * A node that contains `CURRENT_USER` function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#CurrentUserNode Read more...} */ export interface CurrentUserNode { type: "current-user"; location: SQLSourceLocation; } export interface DataTypeNode { type: "data-type"; location: SQLSourceLocation; value: DataTypeNodeValue; } /** * A node that contains date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#DateNode Read more...} */ export interface DateNode { type: "date"; location: SQLSourceLocation; value: string; } /** * A nodes that contains SQL function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#FunctionNode Read more...} */ export interface FunctionNode { type: "function"; location: SQLSourceLocation; name: string; args: ListNode; } /** * Interval node indicates that the character literal is an interval. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#IntervalNode Read more...} */ export interface IntervalNode { type: "interval"; location: SQLSourceLocation; value: StringNode | ParamNode; op: "+" | "-" | ""; qualifier: IntervalQualifierNode | IntervalPeriodNode; } /** * Interval period node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#IntervalPeriodNode Read more...} */ export interface IntervalPeriodNode { type: "interval-period"; location: SQLSourceLocation; period: "day" | "month" | "hour" | "second" | "year" | "minute"; precision: number | nullish; secondary: number | nullish; } /** * Node that contains interval qualifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#IntervalQualifierNode Read more...} */ export interface IntervalQualifierNode { type: "interval-qualifier"; location: SQLSourceLocation; start: IntervalPeriodNode; end: IntervalPeriodNode; } /** * A node that contains a list. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#ListNode Read more...} */ export interface ListNode { type: "expression-list"; location: SQLSourceLocation; value: SQLNode[]; } /** * A node that contains `NULL` value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#NullNode Read more...} */ export interface NullNode { type: "null"; location: SQLSourceLocation; value: null; } /** * A node that contains number. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#NumberNode Read more...} */ export interface NumberNode { type: "number"; location: SQLSourceLocation; value: number; } /** * ParamNode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#ParamNode Read more...} */ export interface ParamNode { type: "parameter"; location: SQLSourceLocation; value: string; } /** * Node that contains case expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#SearchedCaseNode Read more...} */ export interface SearchedCaseNode { type: "case-expression"; location: SQLSourceLocation; format: "searched"; clauses: WhenNode[]; else: SQLNode | nullish; elseLocation?: SQLSourceLocation | nullish; } /** * Simple case expression node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#SimpleCaseNode Read more...} */ export interface SimpleCaseNode { type: "case-expression"; location: SQLSourceLocation; format: "simple"; clauses: WhenNode[]; operand: SQLNode; else: SQLNode | nullish; elseLocation?: SQLSourceLocation | nullish; } /** * SQL parse tree is composed of SqlNodes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#SQLNode Read more...} */ export type SQLNode = | BinaryNode | BoolNode | ColumnNode | CurrentTimeNode | CurrentUserNode | DataTypeNode | DateNode | FunctionNode | IntervalNode | IntervalPeriodNode | IntervalQualifierNode | ListNode | NullNode | NumberNode | ParamNode | SearchedCaseNode | SimpleCaseNode | StringNode | TimeNode | TimeStampNode | UnaryNode | WhenNode; export interface SQLSourceLocation { start: SQLSourcePosition; end: SQLSourcePosition; } export interface SQLSourcePosition { offset: number; line: number; column: number; } export interface SQLSyntaxError { name: "SyntaxError"; location: SQLSourceLocation; message: string; } /** * A node that contains string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#StringNode Read more...} */ export interface StringNode { type: "string"; location: SQLSourceLocation; value: string; } /** * A node that contains time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#TimeNode Read more...} */ export interface TimeNode { type: "time"; location: SQLSourceLocation; value: string; } /** * A node that contains date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#TimeStampNode Read more...} */ export interface TimeStampNode { type: "timestamp"; location: SQLSourceLocation; value: string; } /** * A node that contains unary operator. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#UnaryNode Read more...} */ export interface UnaryNode { type: "unary-expression"; location: SQLSourceLocation; operator: "NOT"; expr: SQLNode; } /** * Node that contains when clause. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-sql-WhereClause.html#WhenNode Read more...} */ export interface WhenNode { type: "when-clause"; location: SQLSourceLocation; operand: SQLNode; value: SQLNode; } export interface DataTypeNodeValue { type: "integer" | "real" | "smallint" | "float" | "date" | "timestamp" | "varchar" | "time"; size?: number; } /** * Types of units used across the JS API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html Read more...} */ namespace units { /** * Units for lengths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#LengthUnit Read more...} */ export type LengthUnit = | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Units for elevations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#ElevationUnit Read more...} */ export type ElevationUnit = __geoscene.LengthUnit | "decimal-degrees" | "unknown"; /** * Units for areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#AreaUnit Read more...} */ export type AreaUnit = | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-nautical-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * Units for volumes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#VolumeUnit Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#AngleUnit Read more...} */ export type AngleUnit = "degrees" | "radians"; /** * Units for angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#Unit Read more...} */ export type Unit = __geoscene.LengthUnit | __geoscene.AreaUnit | __geoscene.VolumeUnit | __geoscene.AngleUnit; /** * Measurement systems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#MeasurementSystem Read more...} */ export type MeasurementSystem = "imperial" | "metric"; /** * Measurement systems or an area units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#SystemOrAreaUnit Read more...} */ export type SystemOrAreaUnit = __geoscene.MeasurementSystem | __geoscene.AreaUnit; /** * Measurement system or an length unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#SystemOrLengthUnit Read more...} */ export type SystemOrLengthUnit = __geoscene.MeasurementSystem | __geoscene.LengthUnit; } /** * Units for angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#AngleUnit Read more...} */ export type AngleUnit = "degrees" | "radians"; /** * Units for areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#AreaUnit Read more...} */ export type AreaUnit = | "square-millimeters" | "square-centimeters" | "square-decimeters" | "square-meters" | "square-kilometers" | "square-inches" | "square-feet" | "square-yards" | "square-miles" | "square-nautical-miles" | "square-us-feet" | "acres" | "ares" | "hectares"; /** * Units for elevations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#ElevationUnit Read more...} */ export type ElevationUnit = LengthUnit | "decimal-degrees" | "unknown"; /** * Units for lengths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#LengthUnit Read more...} */ export type LengthUnit = | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet"; /** * Measurement systems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#MeasurementSystem Read more...} */ export type MeasurementSystem = "imperial" | "metric"; /** * Measurement systems or an area units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#SystemOrAreaUnit Read more...} */ export type SystemOrAreaUnit = MeasurementSystem | AreaUnit; /** * Measurement system or an length unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#SystemOrLengthUnit Read more...} */ export type SystemOrLengthUnit = MeasurementSystem | LengthUnit; /** * Units for angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#Unit Read more...} */ export type Unit = LengthUnit | AreaUnit | VolumeUnit | AngleUnit; /** * Units for volumes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-units.html#VolumeUnit Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html Read more...} */ interface urlUtils { /** * Adds the given proxy rule to the proxy rules list: `geosceneConfig.request.proxyRules`. * * @param rule An object specifying a URL that should use the proxy. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#addProxyRule Read more...} */ addProxyRule(rule: urlUtilsAddProxyRuleRule): number; /** * Converts a base64 encoded data url to an ArrayBuffer. * * @param dataUrl the data url * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#dataToArrayBuffer Read more...} */ dataToArrayBuffer(dataUrl: string): ArrayBuffer | nullish; /** * Converts a base64 encoded data url to a Blob. * * @param dataUrl the data url. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#dataToBlob Read more...} */ dataToBlob(dataUrl: string): Blob | nullish; /** * Trigger a browser file download from a data url encoded as binary data. * * @param blob The data url to download (as binary data. * @param filename the filename. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#downloadBlobAsFile Read more...} */ downloadBlobAsFile(blob: Blob, filename: string): void; /** * Trigger a browser file download from a base64 encoded data url. * * @param dataUrl the data url. * @param filename the filename. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#downloadDataAsFile Read more...} */ downloadDataAsFile(dataUrl: string, filename: string): void; /** * Returns the proxy rule that matches the given URL. * * @param url The URL of the resources accessed via proxy. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#getProxyRule Read more...} */ getProxyRule(url: string): any | nullish; /** * Tests whether a url uses the data protocol. * * @param url The url to test. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#isDataProtocol Read more...} */ isDataProtocol(url: string): boolean; /** * Tests whether a url uses the https protocol. * * @param url The url to test. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#isHTTPSProtocol Read more...} */ isHTTPSProtocol(url: string): boolean; /** * Converts the URL arguments to an object representation. * * @param url The input URL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-urlUtils.html#urlToObject Read more...} */ urlToObject(url: string | nullish): any | nullish; } export const urlUtils: urlUtils; export interface urlUtilsAddProxyRuleRule { proxyUrl: string; 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 * GeoScene Maps SDK for JavaScript. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers.html Read more...} */ interface workers { /** * Opens a connection to workers and loads a script with the workers framework. * * @param modulePath A fully qualified URL to a script to execute with the workers framework. * @param options Worker options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers.html#open Read more...} */ open(modulePath: string, options?: workersOpenOptions): Promise; } export const workers: workers; export class Connection { constructor(); /** * A convenient method that invokes a method on each worker. * * @param methodName The name of the remote method to invoke on all workers. * @param data The unique parameter passed as argument of the remote method. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers-Connection.html#broadcast Read more...} */ broadcast(methodName: string, data?: any, options?: ConnectionBroadcastOptions): Promise[]; /** * Closes the existing connection instance to workers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers-Connection.html#close Read more...} */ close(): void; /** * Invokes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers-Connection.html#basic-invocation method} on the remote module loaded with the worker. * * @param methodName The name of the method to be invoked in the script. * @param data The unique parameter passed as argument of the remote method. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers-Connection.html#multiple-parameters Passing multiple parameters} section to pass more than one parameter to the remote method. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-workers-Connection.html#invoke Read more...} */ invoke(methodName: string, data?: any, options?: ConnectionInvokeOptions): Promise; } export interface ConnectionBroadcastOptions { signal?: AbortSignal | nullish; } export interface ConnectionInvokeOptions { transferList?: any[]; signal?: AbortSignal | nullish; } export interface workersOpenOptions { client?: any; strategy?: "distributed" | "dedicated" | "local"; signal?: AbortSignal | nullish; } /** * Represents the full definition for a shared template, typically obtained from the * `sharedTemplates/templates` endpoint of a feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-editing-sharedTemplates-SharedTemplate.html Read more...} */ interface SharedTemplate { readonly type: "feature" | "group" | "preset"; } export const SharedTemplate: SharedTemplate; /** * Represents the info for a shared template, typically obtained from the * `sharedTemplates/query` endpoint of a feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-editing-sharedTemplates-SharedTemplateMetadata.html Read more...} */ interface SharedTemplateMetadata { templateId: number; type: "feature" | "group" | "preset"; } export const SharedTemplateMetadata: SharedTemplateMetadata; export interface ServiceInfo { url: string; } export interface FocusArea extends Accessor, JSONSupport, Clonable { } export class FocusArea { /** * A boolean indicating whether the focus area is enabled and displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#enabled Read more...} */ enabled: boolean; /** * The unique ID assigned to the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#id Read more...} */ id: string; /** * The title of the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#title Read more...} */ title: string | nullish; /** * Represents a single focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html Read more...} */ constructor(properties?: FocusAreaProperties); /** * The geometries defining the focused area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#geometries Read more...} */ get geometries(): Collection; set geometries(value: CollectionProperties); /** * An object describing the style of the focus area outline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#outline Read more...} */ get outline(): FocusAreaOutline | nullish; set outline(value: FocusAreaOutlineProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FocusArea; } interface FocusAreaProperties { /** * A boolean indicating whether the focus area is enabled and displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#enabled Read more...} */ enabled?: boolean; /** * The geometries defining the focused area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#geometries Read more...} */ geometries?: CollectionProperties; /** * The unique ID assigned to the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#id Read more...} */ id?: string; /** * An object describing the style of the focus area outline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#outline Read more...} */ outline?: FocusAreaOutlineProperties | nullish; /** * The title of the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html#title Read more...} */ title?: string | nullish; } export interface FocusAreaOutline extends Accessor, JSONSupport, Clonable { } export class FocusAreaOutline { /** * Defines the appearance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusArea.html FocusArea} outline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html Read more...} */ constructor(properties?: FocusAreaOutlineProperties); /** * The color of the outline for the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FocusAreaOutline; } interface FocusAreaOutlineProperties { /** * The color of the outline for the focus area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreaOutline.html#color Read more...} */ color?: ColorProperties | nullish; } export interface FocusAreas extends Accessor, JSONSupport, Clonable { } export class FocusAreas { /** * The rendering style of the map, applied outside of all enabled focus areas. * * @default "bright" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#style Read more...} */ style: "bright" | "dark"; /** * A collection of focus areas in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html Read more...} */ constructor(properties?: FocusAreasProperties); /** * A collection containing all focus areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#areas Read more...} */ get areas(): Collection; set areas(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FocusAreas; } interface FocusAreasProperties { /** * A collection containing all focus areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#areas Read more...} */ areas?: CollectionProperties; /** * The rendering style of the map, applied outside of all enabled focus areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html#style Read more...} */ style?: "bright" | "dark"; } /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html Element} classes * when developing with {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html Read more...} */ namespace elements { /** * Form element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#Element Read more...} */ export type Element = | __geoscene.FieldElement | __geoscene.GroupElement | __geoscene.RelationshipElement | __geoscene.TextElement | __geoscene.AttachmentElement | __geoscene.UtilityNetworkAssociationsElement; /** * `FieldElement` defines how a feature layer's field participates in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#FieldElement Read more...} */ export type FieldElement = __geoscene.FieldElement; export const FieldElement: typeof __geoscene.FieldElement; /** * `GroupElement` defines a container that holds a set of form elements * that can be expanded, collapsed, or displayed together. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#GroupElement Read more...} */ export type GroupElement = __geoscene.GroupElement; export const GroupElement: typeof __geoscene.GroupElement; /** * `RelationshipElement` defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#RelationshipElement Read more...} */ export type RelationshipElement = __geoscene.RelationshipElement; export const RelationshipElement: typeof __geoscene.RelationshipElement; /** * `TextElement` form element is used to define descriptive text as an element within a layer or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} and can be used to aid those entering or updating information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#TextElement Read more...} */ export type TextElement = __geoscene.TextElement; export const TextElement: typeof __geoscene.TextElement; /** * `AttachmentElement` defines how one or more attachments can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#AttachmentElement Read more...} */ export type AttachmentElement = __geoscene.AttachmentElement; export const AttachmentElement: typeof __geoscene.AttachmentElement; /** * `UtilityNetworkAssociationsElement` defines how utility network associations can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#UtilityNetworkAssociationsElement Read more...} */ export type UtilityNetworkAssociationsElement = __geoscene.UtilityNetworkAssociationsElement; export const UtilityNetworkAssociationsElement: typeof __geoscene.UtilityNetworkAssociationsElement; } export class AttachmentElement extends Element { /** * Determines whether the user renaming an attachment is allowed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#allowUserRename Read more...} */ allowUserRename: boolean | nullish; /** * A string to identify the attachment(s). * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#attachmentKeyword Read more...} */ attachmentKeyword: string | nullish; /** * Determines whether the file name should be displayed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#displayFilename Read more...} */ displayFilename: boolean | nullish; /** * A reference to an Arcade expression that returns a boolean value. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#editableExpression Read more...} */ editableExpression: string | nullish; /** * Determines the name of a new attachment. * * @default {attachmentKeyword}_{now} * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#filenameExpression Read more...} */ filenameExpression: string | nullish; /** * Defines the maximum number of attachments allowed for this element. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#maxAttachmentCount Read more...} */ maxAttachmentCount: number | nullish; /** * Defines the minimum number of attachments required for this element. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#minAttachmentCount Read more...} */ minAttachmentCount: number | nullish; /** * The type of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#type Read more...} */ readonly type: "attachment"; /** * Determines whether the uploaded attachment's file name is preserved. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#useOriginalFilename Read more...} */ useOriginalFilename: boolean | nullish; /** * An `AttachmentElement` defines how one or more attachments can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html Read more...} */ constructor(properties?: AttachmentElementProperties); /** * The input user interface to use for the attachment. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#input Read more...} */ get input(): AttachmentInput | AudioInput | DocumentInput | ImageInput | SignatureInput | VideoInput | nullish; set input(value: | (AttachmentInputProperties & { type: "attachment" }) | (AudioInputProperties & { type: "audio" }) | (DocumentInputProperties & { type: "document" }) | (ImageInputProperties & { type: "image" }) | (SignatureInputProperties & { type: "signature" }) | (VideoInputProperties & { type: "video" }) | nullish); /** * Creates a deep clone of the AttachmentElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#clone Read more...} */ clone(): AttachmentElement; static fromJSON(json: any): AttachmentElement; } interface AttachmentElementProperties extends ElementProperties { /** * Determines whether the user renaming an attachment is allowed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#allowUserRename Read more...} */ allowUserRename?: boolean | nullish; /** * A string to identify the attachment(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#attachmentKeyword Read more...} */ attachmentKeyword?: string | nullish; /** * Determines whether the file name should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#displayFilename Read more...} */ displayFilename?: boolean | nullish; /** * A reference to an Arcade expression that returns a boolean value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#editableExpression Read more...} */ editableExpression?: string | nullish; /** * Determines the name of a new attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#filenameExpression Read more...} */ filenameExpression?: string | nullish; /** * The input user interface to use for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#input Read more...} */ input?: | (AttachmentInputProperties & { type: "attachment" }) | (AudioInputProperties & { type: "audio" }) | (DocumentInputProperties & { type: "document" }) | (ImageInputProperties & { type: "image" }) | (SignatureInputProperties & { type: "signature" }) | (VideoInputProperties & { type: "video" }) | nullish; /** * Defines the maximum number of attachments allowed for this element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#maxAttachmentCount Read more...} */ maxAttachmentCount?: number | nullish; /** * Defines the minimum number of attachments required for this element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#minAttachmentCount Read more...} */ minAttachmentCount?: number | nullish; /** * Determines whether the uploaded attachment's file name is preserved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-AttachmentElement.html#useOriginalFilename Read more...} */ useOriginalFilename?: boolean | nullish; } export interface Element extends Accessor, JSONSupport { } export class Element { /** * The element's description providing the purpose behind it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#description Read more...} */ description: string | nullish; /** * A string value containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#label Read more...} */ label: string | nullish; /** * The type of form element to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#type Read more...} */ readonly type: "attachment" | "field" | "group" | "relationship" | "text" | "utilityNetworkAssociations"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#visibilityExpression Read more...} */ visibilityExpression: string | nullish; /** * Form elements define what should display within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html Read more...} */ constructor(properties?: ElementProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Element; } interface ElementProperties { /** * The element's description providing the purpose behind it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#description Read more...} */ description?: string | nullish; /** * A string value containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#label Read more...} */ label?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html#visibilityExpression Read more...} */ visibilityExpression?: string | nullish; } export class FieldElement extends Element { /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#editableExpression Read more...} */ editableExpression: string | nullish; /** * The field name as defined by the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#fieldName Read more...} */ fieldName: string | nullish; /** * Contains a hint used to help editors while editing fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#hint Read more...} */ hint: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#requiredExpression Read more...} */ requiredExpression: string | nullish; /** * Indicates the type of form {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#type Read more...} */ readonly type: "field"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * A `FieldElement` form element defines how a feature layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} * participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html Read more...} */ constructor(properties?: FieldElementProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html coded value domain} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html range domain} of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#domain Read more...} */ get domain(): CodedValueDomain | RangeDomain | nullish; set domain(value: | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | nullish); /** * The input to use for the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#input Read more...} */ get input(): | BarcodeScannerInput | ComboBoxInput | DatePickerInput | DateTimeOffsetPickerInput | DateTimePickerInput | TextAreaInput | TextBoxInput | RadioButtonsInput | SwitchInput | TimePickerInput | nullish; set input(value: | (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" }) | nullish); /** * Creates a deep clone of the FieldElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#clone Read more...} */ clone(): FieldElement; static fromJSON(json: any): FieldElement; } interface FieldElementProperties extends ElementProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html coded value domain} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html range domain} of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#domain Read more...} */ domain?: | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#editableExpression Read more...} */ editableExpression?: string | nullish; /** * The field name as defined by the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#fieldName Read more...} */ fieldName?: string | nullish; /** * Contains a hint used to help editors while editing fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#hint Read more...} */ hint?: string | nullish; /** * The input to use for the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#input Read more...} */ 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" }) | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#requiredExpression Read more...} */ requiredExpression?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#valueExpression Read more...} */ valueExpression?: string | nullish; } export class GroupElement extends Element { /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * @default "expanded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#initialState Read more...} */ initialState: "collapsed" | "expanded"; /** * The type of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#type Read more...} */ readonly type: "group"; /** * A `GroupElement` form element defines a container that holds a set of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#elements form elements} * that can be expanded, collapsed, or displayed together. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html Read more...} */ constructor(properties?: GroupElementProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html relationship}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html text} elements to display as grouped. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#elements Read more...} */ get elements(): (FieldElement | RelationshipElement | TextElement)[]; set elements(value: ( | (FieldElementProperties & { type: "field" }) | (RelationshipElementProperties & { type: "relationship" }) | (TextElementProperties & { type: "text" }) )[]); /** * Creates a deep clone of the GroupElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#clone Read more...} */ clone(): GroupElement; static fromJSON(json: any): GroupElement; } interface GroupElementProperties extends ElementProperties { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html relationship}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html text} elements to display as grouped. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#elements Read more...} */ elements?: ( | (FieldElementProperties & { type: "field" }) | (RelationshipElementProperties & { type: "relationship" }) | (TextElementProperties & { type: "text" }) )[]; /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-GroupElement.html#initialState Read more...} */ initialState?: "collapsed" | "expanded"; } /** * A convenience module for importing module:geoscene/form/elements/inputs/Input classes * when developing with {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html Read more...} */ namespace inputs { /** * Form element input types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#Input Read more...} */ export type Input = | __geoscene.BarcodeScannerInput | __geoscene.ComboBoxInput | __geoscene.DatePickerInput | __geoscene.DateTimeOffsetPickerInput | __geoscene.DateTimePickerInput | __geoscene.RadioButtonsInput | __geoscene.SwitchInput | __geoscene.TextAreaInput | __geoscene.TextBoxInput | __geoscene.TimePickerInput; /** * The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#BarcodeScannerInput Read more...} */ export type BarcodeScannerInput = __geoscene.BarcodeScannerInput; export const BarcodeScannerInput: typeof __geoscene.BarcodeScannerInput; /** * The `ComboBoxInput` class defines the desired user interface for a combo box group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#ComboBoxInput Read more...} */ export type ComboBoxInput = __geoscene.ComboBoxInput; export const ComboBoxInput: typeof __geoscene.ComboBoxInput; /** * The `DatePickerInput` class defines the desired user interface for working with date-only types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DatePickerInput Read more...} */ export type DatePickerInput = __geoscene.DatePickerInput; export const DatePickerInput: typeof __geoscene.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). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DateTimeOffsetPickerInput Read more...} */ export type DateTimeOffsetPickerInput = __geoscene.DateTimeOffsetPickerInput; export const DateTimeOffsetPickerInput: typeof __geoscene.DateTimeOffsetPickerInput; /** * The `DateTimePickerInput` class defines the desired user interface for editing date (including time) fields in a form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DateTimePickerInput Read more...} */ export type DateTimePickerInput = __geoscene.DateTimePickerInput; export const DateTimePickerInput: typeof __geoscene.DateTimePickerInput; /** * The `RadioButtonsInput` class defines the desired user interface for a radio button group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#RadioButtonsInput Read more...} */ export type RadioButtonsInput = __geoscene.RadioButtonsInput; export const RadioButtonsInput: typeof __geoscene.RadioButtonsInput; /** * The `SwitchInput` class defines the desired user interface for a binary switch or toggle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#SwitchInput Read more...} */ export type SwitchInput = __geoscene.SwitchInput; export const SwitchInput: typeof __geoscene.SwitchInput; /** * `TextAreaInput` defines the desired user interface is a multi-line text area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TextAreaInput Read more...} */ export type TextAreaInput = __geoscene.TextAreaInput; export const TextAreaInput: typeof __geoscene.TextAreaInput; /** * `TextBoxInput` defines the desired user interface is a single-line text box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TextBoxInput Read more...} */ export type TextBoxInput = __geoscene.TextBoxInput; export const TextBoxInput: typeof __geoscene.TextBoxInput; /** * The `TimePickerInput` class defines the desired user interface for working with time-only types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TimePickerInput Read more...} */ export type TimePickerInput = __geoscene.TimePickerInput; export const TimePickerInput: typeof __geoscene.TimePickerInput; } export interface AttachmentInput extends Accessor, JSONSupport, Clonable { } export class AttachmentInput { /** * String value which indicates if existing attachments should be associated with the element and how they should be associated. * * @default "exact" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#attachmentAssociationType Read more...} */ attachmentAssociationType: "any" | "exact" | "exactOrNone"; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#type Read more...} */ readonly type: "attachment"; /** * The `AttachmentInput` class defines a flexible user interface for an attachment input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html Read more...} */ constructor(properties?: AttachmentInputProperties); /** * Available inputs to add an attachment. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#inputTypes Read more...} */ get inputTypes(): (AudioInput | DocumentInput | ImageInput | SignatureInput | VideoInput)[] | nullish; set inputTypes(value: | ( | (AudioInputProperties & { type: "audio" }) | (DocumentInputProperties & { type: "document" }) | (ImageInputProperties & { type: "image" }) | (SignatureInputProperties & { type: "signature" }) | (VideoInputProperties & { type: "video" }) )[] | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttachmentInput; } interface AttachmentInputProperties { /** * String value which indicates if existing attachments should be associated with the element and how they should be associated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#attachmentAssociationType Read more...} */ attachmentAssociationType?: "any" | "exact" | "exactOrNone"; /** * Available inputs to add an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AttachmentInput.html#inputTypes Read more...} */ inputTypes?: | ( | (AudioInputProperties & { type: "audio" }) | (DocumentInputProperties & { type: "document" }) | (ImageInputProperties & { type: "image" }) | (SignatureInputProperties & { type: "signature" }) | (VideoInputProperties & { type: "video" }) )[] | nullish; } export interface AudioInput extends Accessor, JSONSupport, Clonable { } export class AudioInput { /** * The supported input methods used to attach an audio file. * * @default any * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#inputMethod Read more...} */ inputMethod: "any" | "capture" | "upload"; /** * Defines the maximum length of an attachment for this element in seconds. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#maxDuration Read more...} */ maxDuration: number | nullish; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#type Read more...} */ readonly type: "audio"; /** * The `AudioInput` class defines a user interface for an input to which audio files can be attached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html Read more...} */ constructor(properties?: AudioInputProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AudioInput; } interface AudioInputProperties { /** * The supported input methods used to attach an audio file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#inputMethod Read more...} */ inputMethod?: "any" | "capture" | "upload"; /** * Defines the maximum length of an attachment for this element in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-AudioInput.html#maxDuration Read more...} */ maxDuration?: number | nullish; } export interface DocumentInput extends Accessor, JSONSupport, Clonable { } export class DocumentInput { /** * Defines the maximum length of an attachment for this element in megabytes. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#maxFileSize Read more...} */ maxFileSize: number | nullish; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#type Read more...} */ readonly type: "document"; /** * The `DocumentInput` class defines a user interface for an input to which document files can be attached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html Read more...} */ constructor(properties?: DocumentInputProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DocumentInput; } interface DocumentInputProperties { /** * Defines the maximum length of an attachment for this element in megabytes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-DocumentInput.html#maxFileSize Read more...} */ maxFileSize?: number | nullish; } export interface ImageInput extends Accessor, JSONSupport, Clonable { } export class ImageInput { /** * The supported input methods used to attach an image. * * @default any * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#inputMethod Read more...} */ inputMethod: "any" | "capture" | "upload"; /** * Number of pixels on the longest edge depending on orientation. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#maxImageSize Read more...} */ maxImageSize: number | nullish; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#type Read more...} */ readonly type: "image"; /** * The `ImageInput` class defines a user interface for an input to which image files can be attached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html Read more...} */ constructor(properties?: ImageInputProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageInput; } interface ImageInputProperties { /** * The supported input methods used to attach an image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#inputMethod Read more...} */ inputMethod?: "any" | "capture" | "upload"; /** * Number of pixels on the longest edge depending on orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-ImageInput.html#maxImageSize Read more...} */ maxImageSize?: number | nullish; } export interface SignatureInput extends Accessor, JSONSupport, Clonable { } export class SignatureInput { /** * The supported input methods used to attach a signature. * * @default any * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#inputMethod Read more...} */ inputMethod: "any" | "capture" | "upload"; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#type Read more...} */ readonly type: "signature"; /** * The `SignatureInput` class defines a user interface for an input to which a signature can be attached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html Read more...} */ constructor(properties?: SignatureInputProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SignatureInput; } interface SignatureInputProperties { /** * The supported input methods used to attach a signature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-SignatureInput.html#inputMethod Read more...} */ inputMethod?: "any" | "capture" | "upload"; } export interface VideoInput extends Accessor, JSONSupport, Clonable { } export class VideoInput { /** * The supported input methods used to attach a video. * * @default any * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#inputMethod Read more...} */ inputMethod: "any" | "capture" | "upload"; /** * Defines the maximum length of an attachment for this element in seconds. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#maxDuration Read more...} */ maxDuration: number | nullish; /** * The input type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#type Read more...} */ readonly type: "video"; /** * The `VideoInput` class defines a user interface for an input to which a video file can be attached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html Read more...} */ constructor(properties?: VideoInputProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VideoInput; } interface VideoInputProperties { /** * The supported input methods used to attach a video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#inputMethod Read more...} */ inputMethod?: "any" | "capture" | "upload"; /** * Defines the maximum length of an attachment for this element in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-attachments-VideoInput.html#maxDuration Read more...} */ maxDuration?: number | nullish; } export interface BarcodeScannerInput extends Accessor, TextInput, JSONSupport { } export class BarcodeScannerInput { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#maxLength Read more...} */ declare maxLength: TextInput["maxLength"]; /** * When set, defines the text input's minimum length. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#minLength Read more...} */ declare minLength: TextInput["minLength"]; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#type Read more...} */ readonly type: "barcode-scanner"; /** * The `BarcodeScannerInput` class defines the desired user interface for a barcode or QR code scanner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html Read more...} */ constructor(properties?: BarcodeScannerInputProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BarcodeScannerInput; } interface BarcodeScannerInputProperties extends TextInputProperties { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#maxLength Read more...} */ maxLength?: TextInputProperties["maxLength"]; /** * When set, defines the text input's minimum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-BarcodeScannerInput.html#minLength Read more...} */ minLength?: TextInputProperties["minLength"]; } export interface ComboBoxInput extends Accessor, JSONSupport { } export class ComboBoxInput { /** * The text used to represent a null value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#noValueOptionLabel Read more...} */ noValueOptionLabel: string | nullish; /** * Determines whether a null value option is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#showNoValueOption Read more...} */ showNoValueOption: boolean; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#type Read more...} */ readonly type: "combo-box"; /** * The `ComboBoxInput` class defines the desired user interface for a combo box group input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html Read more...} */ constructor(properties?: ComboBoxInputProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ComboBoxInput; } interface ComboBoxInputProperties { /** * The text used to represent a null value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#noValueOptionLabel Read more...} */ noValueOptionLabel?: string | nullish; /** * Determines whether a null value option is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-ComboBoxInput.html#showNoValueOption Read more...} */ showNoValueOption?: boolean; } export interface DatePickerInput extends Accessor, JSONSupport { } export class DatePickerInput { /** * The maximum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#max Read more...} */ max: string | nullish; /** * The minimum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#min Read more...} */ min: string | nullish; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#type Read more...} */ readonly type: "date-picker"; /** * The `DatePickerInput` class defines the desired user interface for editing `date-only` field {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type type} input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html Read more...} */ constructor(properties?: DatePickerInputProperties); /** * Creates a deep clone of the `DatePickerInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#clone Read more...} */ clone(): DatePickerInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DatePickerInput; } interface DatePickerInputProperties { /** * The maximum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#max Read more...} */ max?: string | nullish; /** * The minimum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DatePickerInput.html#min Read more...} */ min?: string | nullish; } export interface DateTimeOffsetPickerInput extends Accessor, JSONSupport { } export class DateTimeOffsetPickerInput { /** * Indicates if the input should provide an option to select the time offset. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#includeTimeOffset Read more...} */ includeTimeOffset: boolean; /** * The maximum date/time offset to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#max Read more...} */ max: string | nullish; /** * The minimum date/time offset to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#min Read more...} */ min: string | nullish; /** * The level of detail used to represent time. * * @default "minutes" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#timeResolution Read more...} */ timeResolution: "minutes" | "seconds" | "milliseconds"; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#type Read more...} */ readonly type: "datetimeoffset-picker"; /** * The `DateTimeOffsetPickerInput` class defines the desired user interface for editing `timestamp-offset` field {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type type} input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html Read more...} */ constructor(properties?: DateTimeOffsetPickerInputProperties); /** * Creates a deep clone of the `DateTimeOffsetPickerInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#clone Read more...} */ clone(): DateTimeOffsetPickerInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DateTimeOffsetPickerInput; } interface DateTimeOffsetPickerInputProperties { /** * Indicates if the input should provide an option to select the time offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#includeTimeOffset Read more...} */ includeTimeOffset?: boolean; /** * The maximum date/time offset to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#max Read more...} */ max?: string | nullish; /** * The minimum date/time offset to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#min Read more...} */ min?: string | nullish; /** * The level of detail used to represent time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimeOffsetPickerInput.html#timeResolution Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#includeTime Read more...} */ includeTime: boolean; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#type Read more...} */ readonly type: "datetime-picker"; /** * The `DateTimePickerInput` class defines the desired user interface for editing `date` field {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type type} input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html Read more...} */ constructor(properties?: DateTimePickerInputProperties); /** * The maximum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#max Read more...} */ get max(): Date | nullish; set max(value: DateProperties | nullish); /** * The minimum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#min Read more...} */ get min(): Date | nullish; set min(value: DateProperties | nullish); /** * Creates a deep clone of the `DateTimePickerInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#clone Read more...} */ clone(): DateTimePickerInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DateTimePickerInput; } interface DateTimePickerInputProperties { /** * Indicates if the input should provide an option to select the time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#includeTime Read more...} */ includeTime?: boolean; /** * The maximum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#max Read more...} */ max?: DateProperties | nullish; /** * The minimum date to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-DateTimePickerInput.html#min Read more...} */ min?: DateProperties | nullish; } export interface RadioButtonsInput extends Accessor, JSONSupport { } export class RadioButtonsInput { /** * The text used to represent a null value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#noValueOptionLabel Read more...} */ noValueOptionLabel: string | nullish; /** * Determines whether a null value option is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#showNoValueOption Read more...} */ showNoValueOption: boolean; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#type Read more...} */ readonly type: "radio-buttons"; /** * The `RadioButtonsInput` class defines the desired user interface for a radio button group input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html Read more...} */ constructor(properties?: RadioButtonsInputProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RadioButtonsInput; } interface RadioButtonsInputProperties { /** * The text used to represent a null value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#noValueOptionLabel Read more...} */ noValueOptionLabel?: string | nullish; /** * Determines whether a null value option is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-RadioButtonsInput.html#showNoValueOption Read more...} */ showNoValueOption?: boolean; } export interface SwitchInput extends Accessor, JSONSupport { } export class SwitchInput { /** * Coded value used when the switch state is turned off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#offValue Read more...} */ offValue: string | number; /** * Coded value used when the switch state is turned on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#onValue Read more...} */ onValue: string | number; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#type Read more...} */ readonly type: "switch"; /** * The `SwitchInput` class defines the desired user interface for a binary switch or toggle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html Read more...} */ constructor(properties?: SwitchInputProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SwitchInput; } interface SwitchInputProperties { /** * Coded value used when the switch state is turned off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#offValue Read more...} */ offValue?: string | number; /** * Coded value used when the switch state is turned on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-SwitchInput.html#onValue Read more...} */ onValue?: string | number; } export interface TextAreaInput extends JSONSupport, TextInput { } export class TextAreaInput { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#maxLength Read more...} */ declare maxLength: TextInput["maxLength"]; /** * When set, defines the text input's minimum length. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#minLength Read more...} */ declare minLength: TextInput["minLength"]; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#type Read more...} */ readonly type: "text-area"; /** * The `TextAreaInput` class defines the desired user interface as a multi-line text area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html Read more...} */ constructor(properties?: TextAreaInputProperties); /** * Creates a deep clone of the `TextAreaInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#clone Read more...} */ clone(): TextAreaInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TextAreaInput; } interface TextAreaInputProperties extends TextInputProperties { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#maxLength Read more...} */ maxLength?: TextInputProperties["maxLength"]; /** * When set, defines the text input's minimum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextAreaInput.html#minLength Read more...} */ minLength?: TextInputProperties["minLength"]; } export interface TextBoxInput extends Accessor, JSONSupport, TextInput { } export class TextBoxInput { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#maxLength Read more...} */ declare maxLength: TextInput["maxLength"]; /** * When set, defines the text input's minimum length. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#minLength Read more...} */ declare minLength: TextInput["minLength"]; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#type Read more...} */ readonly type: "text-box"; /** * The `TextBoxInput` class defines the desired user interface as a single-line text box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html Read more...} */ constructor(properties?: TextBoxInputProperties); /** * Creates a deep clone of the `TextBoxInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#clone Read more...} */ clone(): TextBoxInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TextBoxInput; } interface TextBoxInputProperties extends TextInputProperties { /** * When set, defines the text input's maximum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#maxLength Read more...} */ maxLength?: TextInputProperties["maxLength"]; /** * When set, defines the text input's minimum length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TextBoxInput.html#minLength Read more...} */ minLength?: TextInputProperties["minLength"]; } export class TextInput { maxLength: number | nullish; minLength: number | nullish; } interface TextInputProperties { maxLength?: number | nullish; minLength?: number | nullish; } export interface TimePickerInput extends Accessor, JSONSupport { } export class TimePickerInput { /** * The maximum time to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#max Read more...} */ max: string | nullish; /** * The minimum time to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#min Read more...} */ min: string | nullish; /** * The level of detail used to represent time. * * @default "minutes" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#timeResolution Read more...} */ timeResolution: "minutes" | "seconds"; /** * The type of form element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#type Read more...} */ readonly type: "time-picker"; /** * The `TimePickerInput` class defines the desired user interface for editing `time-only` field {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type type} input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html Read more...} */ constructor(properties?: TimePickerInputProperties); /** * Creates a deep clone of the `TimePickerInput` class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#clone Read more...} */ clone(): TimePickerInput; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TimePickerInput; } interface TimePickerInputProperties { /** * The maximum time to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#max Read more...} */ max?: string | nullish; /** * The minimum time to allow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#min Read more...} */ min?: string | nullish; /** * The level of detail used to represent time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs-TimePickerInput.html#timeResolution Read more...} */ timeResolution?: "minutes" | "seconds"; } /** * The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#BarcodeScannerInput Read more...} */ export type inputsBarcodeScannerInput = BarcodeScannerInput; /** * The `ComboBoxInput` class defines the desired user interface for a combo box group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#ComboBoxInput Read more...} */ export type inputsComboBoxInput = ComboBoxInput; /** * The `DatePickerInput` class defines the desired user interface for working with date-only types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DatePickerInput Read more...} */ 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). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DateTimeOffsetPickerInput Read more...} */ export type inputsDateTimeOffsetPickerInput = DateTimeOffsetPickerInput; /** * The `DateTimePickerInput` class defines the desired user interface for editing date (including time) fields in a form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#DateTimePickerInput Read more...} */ export type inputsDateTimePickerInput = DateTimePickerInput; /** * Form element input types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#Input Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#RadioButtonsInput Read more...} */ export type inputsRadioButtonsInput = RadioButtonsInput; /** * The `SwitchInput` class defines the desired user interface for a binary switch or toggle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#SwitchInput Read more...} */ export type inputsSwitchInput = SwitchInput; /** * `TextAreaInput` defines the desired user interface is a multi-line text area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TextAreaInput Read more...} */ export type inputsTextAreaInput = TextAreaInput; /** * `TextBoxInput` defines the desired user interface is a single-line text box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TextBoxInput Read more...} */ export type inputsTextBoxInput = TextBoxInput; /** * The `TimePickerInput` class defines the desired user interface for working with time-only types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-inputs.html#TimePickerInput Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#displayCount Read more...} */ displayCount: number | nullish; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#displayType Read more...} */ displayType: "list"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#editableExpression Read more...} */ editableExpression: string | nullish; /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#relationshipId Read more...} */ relationshipId: number; /** * Indicates the type of form {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#type Read more...} */ readonly type: "relationship"; /** * A `RelationshipElement` form element defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html Read more...} */ constructor(properties?: RelationshipElementProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} * objects indicating the field display order for the related records * and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#orderByFields Read more...} */ get orderByFields(): RelatedRecordsInfoFieldOrder[] | nullish; set orderByFields(value: RelatedRecordsInfoFieldOrderProperties[] | nullish); /** * Creates a deep clone of the RelationshipElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#displayCount Read more...} */ displayCount?: number | nullish; /** * A string value indicating how to display related records within the relationship content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#displayType Read more...} */ displayType?: "list"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#editableExpression Read more...} */ editableExpression?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} * objects indicating the field display order for the related records * and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#orderByFields Read more...} */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[] | nullish; /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-RelationshipElement.html#relationshipId Read more...} */ relationshipId?: number; } export class TextElement extends Element { /** * The formatted string content to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#text Read more...} */ text: string | nullish; /** * Defines the format of the `text` property. * * @default "plain-text" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#textFormat Read more...} */ textFormat: "plain-text" | "markdown"; /** * Indicates the type of form {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#type Read more...} */ readonly type: "text"; /** * A `TextElement` form element is used to define descriptive text as an element within a layer or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} and can be used to aid those entering or updating information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html Read more...} */ constructor(properties?: TextElementProperties); /** * Creates a deep clone of the TextElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#clone Read more...} */ clone(): TextElement; static fromJSON(json: any): TextElement; } interface TextElementProperties extends ElementProperties { /** * The formatted string content to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#text Read more...} */ text?: string | nullish; /** * Defines the format of the `text` property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-TextElement.html#textFormat Read more...} */ textFormat?: "plain-text" | "markdown"; } export class UtilityNetworkAssociationsElement extends Element { /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html#editableExpression Read more...} */ editableExpression: string | nullish; /** * Indicates the type of form {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html#type Read more...} */ readonly type: "utilityNetworkAssociations"; /** * The `UtilityNetworkAssociationsElement` defines how utility network associations can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html Read more...} */ constructor(properties?: UtilityNetworkAssociationsElementProperties); /** * The association types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html#associationTypes Read more...} */ get associationTypes(): UtilityNetworkAssociationType[]; set associationTypes(value: UtilityNetworkAssociationTypeProperties[]); static fromJSON(json: any): UtilityNetworkAssociationsElement; } interface UtilityNetworkAssociationsElementProperties extends ElementProperties { /** * The association types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html#associationTypes Read more...} */ associationTypes?: UtilityNetworkAssociationTypeProperties[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name name} of an * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression defined in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos expressionInfos} of the FormTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-UtilityNetworkAssociationsElement.html#editableExpression Read more...} */ editableExpression?: string | nullish; } /** * `AttachmentElement` defines how one or more attachments can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#AttachmentElement Read more...} */ export type elementsAttachmentElement = AttachmentElement; /** * Form element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#Element Read more...} */ export type elementsElement = | FieldElement | GroupElement | RelationshipElement | TextElement | AttachmentElement | UtilityNetworkAssociationsElement; /** * `FieldElement` defines how a feature layer's field participates in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#FieldElement Read more...} */ export type elementsFieldElement = FieldElement; /** * `GroupElement` defines a container that holds a set of form elements * that can be expanded, collapsed, or displayed together. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#GroupElement Read more...} */ export type elementsGroupElement = GroupElement; /** * `RelationshipElement` defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#RelationshipElement Read more...} */ export type elementsRelationshipElement = RelationshipElement; /** * `TextElement` form element is used to define descriptive text as an element within a layer or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} and can be used to aid those entering or updating information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#TextElement Read more...} */ export type elementsTextElement = TextElement; /** * `UtilityNetworkAssociationsElement` defines how utility network associations can participate in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements.html#UtilityNetworkAssociationsElement Read more...} */ export type elementsUtilityNetworkAssociationsElement = UtilityNetworkAssociationsElement; export interface ExpressionInfo extends Accessor, JSONSupport { } export class ExpressionInfo { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#forms Form Constraint} or {@link https://doc.geoscene.cn/javascript/4.33/arcade/#form-calculation Form Calculation} profiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#expression Read more...} */ expression: string; /** * The name of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name Read more...} */ name: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#returnType Read more...} */ returnType: "boolean" | "date" | "number" | "string"; /** * The title used to describe the value returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#title Read more...} */ title: string | nullish; /** * The `ExpressionInfo` class defines the makeup of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#visibilityExpression visibility expressions}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#requiredExpression required expressions}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#editableExpression editable expressions}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html#valueExpression value expressions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html Read more...} */ constructor(properties?: ExpressionInfoProperties); /** * Creates a deep clone of the ExpressionInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#clone Read more...} */ clone(): ExpressionInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ExpressionInfo; } interface ExpressionInfoProperties { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#forms Form Constraint} or {@link https://doc.geoscene.cn/javascript/4.33/arcade/#form-calculation Form Calculation} profiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#expression Read more...} */ expression?: string; /** * The name of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#name Read more...} */ name?: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#returnType Read more...} */ returnType?: "boolean" | "date" | "number" | "string"; /** * The title used to describe the value returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html#title Read more...} */ title?: string | nullish; } export interface FormTemplate extends Accessor, JSONSupport { } export class FormTemplate { /** * The description of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#description Read more...} */ description: string | nullish; /** * Indicates whether to retain or clear a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html form's} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html field element} values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#preserveFieldValuesWhenHidden Read more...} */ preserveFieldValuesWhenHidden: boolean; /** * The string defining how to format the title displayed at the top of a form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#title Read more...} */ title: string | nullish; /** * A `FormTemplate` formats and defines the content of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} for * a specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html Featurelayer} or SubtypeSubLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html Read more...} */ constructor(properties?: FormTemplateProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html form element} * objects that represent an ordered list of form elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#elements Read more...} */ get elements(): | ( | AttachmentElement | FieldElement | GroupElement | RelationshipElement | TextElement | UtilityNetworkAssociationsElement )[] | nullish; set elements(value: | ( | (AttachmentElementProperties & { type: "attachment" }) | (FieldElementProperties & { type: "field" }) | (GroupElementProperties & { type: "group" }) | (RelationshipElementProperties & { type: "relationship" }) | (TextElementProperties & { type: "text" }) | (UtilityNetworkAssociationsElementProperties & { type: "utilityNetworkAssociations" }) )[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html ExpressionInfo} objects * that reference {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#constraint Form Constraint Profile} or the * {@link https://doc.geoscene.cn/javascript/4.33/arcade/#form-calculation Form Calculation Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos Read more...} */ get expressionInfos(): ExpressionInfo[] | nullish; set expressionInfos(value: ExpressionInfoProperties[] | nullish); /** * Creates a deep clone of the FormTemplate class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#clone Read more...} */ clone(): FormTemplate; /** * Returns the names of all fields represented or referenced in any way by the * FormTemplate. * * @param fieldsIndex The field index. It can be used to make case-insensitive lookup by name for fields used in the `FormTemplate`. * @param relationships An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html Relationship} objects that define the relationships on the layer with which the `FormTemplate` is associated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#getFieldsUsed Read more...} */ getFieldsUsed(fieldsIndex?: FieldsIndex, relationships?: Relationship[]): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FormTemplate; } interface FormTemplateProperties { /** * The description of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#description Read more...} */ description?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-Element.html form element} * objects that represent an ordered list of form elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#elements Read more...} */ elements?: | ( | (AttachmentElementProperties & { type: "attachment" }) | (FieldElementProperties & { type: "field" }) | (GroupElementProperties & { type: "group" }) | (RelationshipElementProperties & { type: "relationship" }) | (TextElementProperties & { type: "text" }) | (UtilityNetworkAssociationsElementProperties & { type: "utilityNetworkAssociations" }) )[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-ExpressionInfo.html ExpressionInfo} objects * that reference {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#constraint Form Constraint Profile} or the * {@link https://doc.geoscene.cn/javascript/4.33/arcade/#form-calculation Form Calculation Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#expressionInfos Read more...} */ expressionInfos?: ExpressionInfoProperties[] | nullish; /** * Indicates whether to retain or clear a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html form's} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-elements-FieldElement.html field element} values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#preserveFieldValuesWhenHidden Read more...} */ preserveFieldValuesWhenHidden?: boolean; /** * The string defining how to format the title displayed at the top of a form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html#title Read more...} */ title?: string | nullish; } /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} classes when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes} to import union types, or individual modules to import classes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html Read more...} */ namespace geometry { /** * Spatial Reference. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/SpatialReference} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#SpatialReference Read more...} */ export type SpatialReference = __geoscene.SpatialReference; export const SpatialReference: typeof __geoscene.SpatialReference; /** * Geometry types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~GeometryUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Geometry Read more...} */ export type Geometry = | __geoscene.Extent | __geoscene.Multipoint | __geoscene.Point | __geoscene.Polygon | __geoscene.Polyline | __geoscene.Mesh; /** * Extent. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Extent} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Extent Read more...} */ export type Extent = __geoscene.Extent; export const Extent: typeof __geoscene.Extent; /** * Multipoint. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Multipoint} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Multipoint Read more...} */ export type Multipoint = __geoscene.Multipoint; export const Multipoint: typeof __geoscene.Multipoint; /** * Point. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Point} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Point Read more...} */ export type Point = __geoscene.Point; export const Point: typeof __geoscene.Point; /** * Polygon. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Polygon} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Polygon Read more...} */ export type Polygon = __geoscene.Polygon; export const Polygon: typeof __geoscene.Polygon; /** * Polyline. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Polyline} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Polyline Read more...} */ export type Polyline = __geoscene.Polyline; export const Polyline: typeof __geoscene.Polyline; } export class Circle extends Polygon { /** * Applicable when the spatial reference of the center point is either set to Web * Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#geodesic Read more...} */ geodesic: boolean; /** * This value defines the number of points * along the curve of the circle. * * @default 60 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#numberOfPoints Read more...} */ numberOfPoints: number; /** * The radius of the circle. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#radius Read more...} */ radius: number; /** * Unit of the radius. * * @default "meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#radiusUnit Read more...} */ radiusUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; /** * A circle is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} created by specifying a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#center center point} * and a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#radius radius}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html Read more...} */ constructor(properties?: CircleProperties); /** * The center point of the circle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#center Read more...} */ get center(): Point | nullish; set center(value: PointProperties | nullish | number[]); /** * Creates a deep clone of Circle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#clone Read more...} */ clone(): Circle; static fromJSON(json: any): Circle; } interface CircleProperties extends PolygonProperties { /** * The center point of the circle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#center Read more...} */ center?: PointProperties | nullish | number[]; /** * Applicable when the spatial reference of the center point is either set to Web * Mercator (wkid: 3857) or geographic/geodesic (wkid: 4326). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#geodesic Read more...} */ geodesic?: boolean; /** * This value defines the number of points * along the curve of the circle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#numberOfPoints Read more...} */ numberOfPoints?: number; /** * The radius of the circle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#radius Read more...} */ radius?: number; /** * Unit of the radius. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Circle.html#radiusUnit Read more...} */ radiusUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards"; } /** * Converts between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html points} and formatted coordinates notation strings * such as: * * decimal degrees * * degrees, minutes, and seconds * * U.S. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html Read more...} */ interface coordinateFormatter { /** * Parses coordinates in latitude/longitude notation, and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing that location. * * @param coordinates The latitude/longitude notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm). If `null`, WGS84 will be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#fromLatitudeLongitude Read more...} */ fromLatitudeLongitude(coordinates: string, spatialReference?: SpatialReference | null): Point | nullish; /** * Parses coordinates in Military Grid Reference System (MGRS) notation, and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing that location. * * @param coordinates The MGRS notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm) referenced by the MGRS coordinates. If `null`, WGS84 will be used. * @param conversionMode The mode used by the given MGRS coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#fromMgrs Read more...} */ fromMgrs(coordinates: string, spatialReference: SpatialReference | nullish, conversionMode: | "automatic" | "new-180-in-zone-01" | "new-180-in-zone-60" | "old-180-in-zone-01" | "old-180-in-zone-60"): Point | nullish; /** * Parses coordinates in United States National Grid (USNG) notation, and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing that location. * * @param coordinates The USNG notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm) that the USNG coordinates are in. If `null`, WGS84 will be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#fromUsng Read more...} */ fromUsng(coordinates: string, spatialReference?: SpatialReference | null): Point | nullish; /** * Parses coordinates in Universal Transverse Mercator (UTM) notation, and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing that location. * * @param coordinates The UTM notation string for the coordinates. * @param spatialReference A spatial reference object representing a [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm) that the UTM coordinates are in. If `null`, WGS84 will be used. * @param conversionMode The latitude notation scheme used by the given UTM coordinates, either a latitudinal band, or a hemisphere designator. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#fromUtm Read more...} */ fromUtm(coordinates: string, spatialReference: SpatialReference | nullish, conversionMode: "latitude-band-indicators" | "north-south-indicators"): Point | nullish; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Indicates if this module is supported in the current browser. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#isSupported Read more...} */ isSupported(): boolean; /** * Load this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#load Read more...} */ load(): Promise; /** * Returns formatted coordinates in latitude/longitude notation representing the given point's location. * * @param point The location to be represented as a formatted latitude/longitude string. The point's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#spatialReference spatial reference} should either be WGS84 or another [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm). * @param format The mode to use when formatting the latitude/longitude string. * @param decimalPlaces The number of decimal places to use, it should be an integer from 0 to 16. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#toLatitudeLongitude Read more...} */ toLatitudeLongitude(point: Point, format: "dd" | "ddm" | "dms", decimalPlaces?: number): string | nullish; /** * Returns formatted coordinates in Military Grid Reference System (MGRS) notation representing the given point's location. * * @param point The location to be represented in MGRS notation. The point's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#spatialReference spatial reference} should either be WGS84 or another [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm) * @param conversionMode The mode to use for the returned MGRS notation string. * @param precision The precision with which to represent the coordinates, it should be an integer from 0 to 8. * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the grid zone designator, the 100km square identifier, and the numerical easting and northing values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#toMgrs Read more...} */ 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 | nullish; /** * Returns formatted coordinates in United States National Grid (USNG) notation representing the given point's location. * * @param point The location to be represented in USNG notation. The point's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#spatialReference spatial reference} should either be WGS84 or another [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm). * @param precision The precision with which to represent the coordinates, it should be an integer from 0 to 8. * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the grid zone designator, the 100km square identifier, and the numerical easting and northing values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#toUsng Read more...} */ toUsng(point: Point, precision?: number, addSpaces?: boolean): string | nullish; /** * Returns formatted coordinates in Universal Transverse Mercator (UTM) notation representing the given point's location. * * @param point The location to be represented in UTM notation. The point's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#spatialReference spatial reference} should either be WGS84 or another [geographic coordinate system](https://doc.geoscene.cn/rest/services-reference/enterprise/using-spatial-references.htm) * @param conversionMode The latitude notation scheme to use in the returned UTM notation string, either a latitudinal band, or a hemisphere designator. * @param addSpaces If `false`, the generated string will contain no spaces. If `true`, a space separates the UTM zone and latitude designator and each numerical easting and northing value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-coordinateFormatter.html#toUtm Read more...} */ toUtm(point: Point, conversionMode: "latitude-band-indicators" | "north-south-indicators", addSpaces?: boolean): string | nullish; } export const coordinateFormatter: coordinateFormatter; export class Extent extends Geometry { /** * The center point of the extent in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#center Read more...} */ readonly center: Point; /** * The height of the extent in map units (the distance between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymin ymin} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymax ymax}). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#height Read more...} */ readonly height: number; /** * The maximum possible `m` value in an extent envelope. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#mmax Read more...} */ mmax: number | undefined; /** * The minimum possible `m` value of an extent envelope. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#mmin Read more...} */ mmin: number | undefined; readonly type: "extent"; /** * The width of the extent in map units (the distance between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmin xmin} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmax xmax}). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#width Read more...} */ readonly width: number; /** * The maximum X-coordinate of an extent envelope. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmax Read more...} */ xmax: number; /** * The minimum X-coordinate of an extent envelope. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmin Read more...} */ xmin: number; /** * The maximum Y-coordinate of an extent envelope. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymax Read more...} */ ymax: number; /** * The minimum Y-coordinate of an extent envelope. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymin Read more...} */ ymin: number; /** * The maximum possible `z`, or elevation, value in an extent envelope. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#zmax Read more...} */ zmax: number | undefined; /** * The minimum possible `z`, or elevation, value of an extent envelope. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#zmin Read more...} */ zmin: number | undefined; /** * The minimum and maximum X and Y coordinates of a bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Read more...} */ constructor(properties?: ExtentProperties); /** * Centers the extent to the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * @param point The point to center the extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#centerAt Read more...} */ centerAt(point: Point): Extent; /** * Creates a deep clone of Extent object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#clone Read more...} */ clone(): Extent; /** * Checks if the input geometry is contained within the extent. * * @param geometry Input geometry to test if it is contained within the extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#contains Read more...} */ contains(geometry: Point | Extent): boolean; /** * Indicates if the input extent is equal to the testing extent. * * @param extent Input extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#equals Read more...} */ equals(extent: Extent | nullish): boolean; /** * Expands the extent by the given factor. * * @param factor The multiplier value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#expand Read more...} */ expand(factor: number): Extent; /** * Shrinks the original extent to the intersection with the input extent. * * @param extent The input extent to intersect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#intersection Read more...} */ intersection(extent: Extent | nullish): Extent | nullish; /** * Tests to validate if the input geometry intersects the extent and returns a Boolean value. * * @param geometry The geometry used to test the intersection. It can be a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html Multipoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#intersects Read more...} */ intersects(geometry: GeometryUnion | nullish): 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#normalize Read more...} */ normalize(): Extent[]; /** * Modifies the extent geometry in-place with X and Y offsets in map units. * * @param dx The offset distance in map units for the X-coordinate. * @param dy The offset distance in map units for the Y-coordinate. * @param dz The offset distance in map units for the Z-coordinate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#offset Read more...} */ offset(dx: number, dy: number, dz?: number): Extent; /** * Expands the original extent to include the extent of the input Extent. * * @param extent The input extent to union. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#union Read more...} */ union(extent: Extent): Extent; static fromJSON(json: any): Extent; } interface ExtentProperties extends GeometryProperties { /** * The maximum possible `m` value in an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#mmax Read more...} */ mmax?: number | undefined; /** * The minimum possible `m` value of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#mmin Read more...} */ mmin?: number | undefined; /** * The maximum X-coordinate of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmax Read more...} */ xmax?: number; /** * The minimum X-coordinate of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#xmin Read more...} */ xmin?: number; /** * The maximum Y-coordinate of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymax Read more...} */ ymax?: number; /** * The minimum Y-coordinate of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#ymin Read more...} */ ymin?: number; /** * The maximum possible `z`, or elevation, value in an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#zmax Read more...} */ zmax?: number | undefined; /** * The minimum possible `z`, or elevation, value of an extent envelope. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html#zmin Read more...} */ zmin?: number | undefined; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#cache Read more...} */ readonly cache: any; /** * The extent of the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#extent Read more...} */ readonly extent: Extent | nullish; /** * Indicates if the geometry has M values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#hasM Read more...} */ hasM: boolean; /** * Indicates if the geometry has z-values (elevation). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#hasZ Read more...} */ hasZ: boolean; /** * The geometry type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#type Read more...} */ readonly type: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * The base class for geometry objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Read more...} */ constructor(properties?: GeometryProperties); /** * The spatial reference of the geometry. * * @default SpatialReference.WGS84 // wkid: 4326 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Creates a deep clone of the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#clone Read more...} */ clone(): Geometry; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Geometry; } interface GeometryProperties { /** * Indicates if the geometry has M values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#hasM Read more...} */ hasM?: boolean; /** * Indicates if the geometry has z-values (elevation). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#hasZ Read more...} */ hasZ?: boolean; /** * The spatial reference of the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; } /** * A client-side geometry engine for testing, measuring, and analyzing the spatial relationship * between two or more 2D geometries. * * @deprecated since version 4.32. Use [geometry operators](../spatial-analysis/intro-geometry-operators/) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html Read more...} */ interface geometryEngine { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. * @param unionResults Determines whether the output geometries should be unioned into a single polygon. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/bufferOperator bufferOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#buffer Read more...} */ buffer(geometry: GeometryUnion | GeometryUnion[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Polygon | Polygon[]; /** * Calculates the clipped geometry from a target geometry by an envelope. * * @param geometry The geometry to be clipped. * @param envelope The envelope used to clip. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/clipOperator clipOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#clip Read more...} */ clip(geometry: GeometryUnion, envelope: Extent): GeometryUnion; /** * Indicates if one geometry contains another geometry. * * @param containerGeometry The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the `insideGeometry`. * @param insideGeometry The geometry that is tested for the "within" relationship to the `containerGeometry`. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/containsOperator containsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#contains Read more...} */ contains(containerGeometry: GeometryUnion, insideGeometry: GeometryUnion): boolean; /** * Calculates the convex hull of one or more geometries. * * @param geometry The input geometry or geometries used to calculate the convex hull. If an array is specified, the input array can include various geometry types. When an array is provided, the output will also be an array. * @param merge Indicates whether to merge the output into a single geometry (usually a polygon). * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/convexHullOperator convexHullOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#convexHull Read more...} */ convexHull(geometry: GeometryUnion | GeometryUnion[], merge?: boolean): GeometryUnion | GeometryUnion[]; /** * Indicates if one geometry crosses another geometry. * * @param geometry1 The geometry to cross. * @param geometry2 The geometry being crossed. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/crossesOperator crossesOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#crosses Read more...} */ crosses(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * Splits the input Polyline or Polygon where it crosses a cutting Polyline. * * @param geometry The geometry to be cut. * @param cutter The polyline to cut the geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/cutOperator cutOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#cut Read more...} */ cut(geometry: GeometryUnion, cutter: Polyline): GeometryUnion[]; /** * Densify geometries by plotting points between existing vertices. * * @param geometry The geometry to be densified. * @param maxSegmentLength The maximum segment length allowed. Must be a positive value. * @param maxSegmentLengthUnit Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/densifyOperator densifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#densify Read more...} */ densify(geometry: GeometryUnion, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits | number): GeometryUnion; /** * Creates the difference of two geometries. * * @param inputGeometry The input geometry to subtract from. * @param subtractor The geometry being subtracted from inputGeometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/differenceOperator differenceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#difference Read more...} */ difference(inputGeometry: GeometryUnion | GeometryUnion[], subtractor: GeometryUnion): GeometryUnion | GeometryUnion[]; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. * * @param geometry1 The base geometry that is tested for the "disjoint" relationship to the other geometry. * @param geometry2 The comparison geometry that is tested for the "disjoint" relationship to the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/disjointOperator disjointOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#disjoint Read more...} */ disjoint(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * Calculates the shortest planar distance between two geometries. * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @param distanceUnit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/distanceOperator distanceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#distance Read more...} */ distance(geometry1: GeometryUnion, geometry2: GeometryUnion, distanceUnit?: LinearUnits | nullish): number; /** * Indicates if two geometries are equal. * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/equalsOperator equalsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#equals Read more...} */ equals(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * Returns an object containing additional information about the input spatial reference. * * @param spatialReference The input spatial reference. * @deprecated since version 4.32. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#extendedSpatialReferenceInfo Read more...} */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): SpatialReferenceInfo; /** * Flips a geometry on the horizontal axis. * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#flipY Transformation's flipY()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#flipHorizontal Read more...} */ flipHorizontal(geometry: GeometryUnion, flipOrigin?: Point | nullish): GeometryUnion; /** * Flips a geometry on the vertical axis. * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#flipX Transformation's flipX()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#flipVertical Read more...} */ flipVertical(geometry: GeometryUnion, flipOrigin?: Point | nullish): GeometryUnion; /** * Performs the generalize operation on the geometries in the cursor. * * @param geometry The input geometry to be generalized. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. * @param removeDegenerateParts When `true` the degenerate parts of the geometry will be removed from the output (may be undesired for drawing). * @param maxDeviationUnit Measurement unit for maxDeviation. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/generalizeOperator generalizeOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#generalize Read more...} */ generalize(geometry: GeometryUnion, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: LinearUnits | number): GeometryUnion; /** * Calculates the area of the input geometry. * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticAreaOperator geodeticAreaOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#geodesicArea Read more...} */ geodesicArea(geometry: Polygon, unit?: AreaUnits | number): number; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. * @param unionResults Determines whether the output geometries should be unioned into a single polygon. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodesicBufferOperator geodesicBufferOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#geodesicBuffer Read more...} */ geodesicBuffer(geometry: GeometryUnion | GeometryUnion[], distance: number | number[], unit?: LinearUnits | number, unionResults?: boolean): Polygon | Polygon[]; /** * Returns a geodetically densified version of the input geometry. * * @param geometry A polyline or polygon to densify. * @param maxSegmentLength The maximum segment length allowed (in meters if a `maxSegmentLengthUnit` is not provided). This must be a positive value. * @param maxSegmentLengthUnit Measurement unit for `maxSegmentLength`. If not provided, the unit will default to `meters`. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticDensifyOperator geodeticDensifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#geodesicDensify Read more...} */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): GeometryUnion; /** * Calculates the length of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticLengthOperator geodeticLengthOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#geodesicLength Read more...} */ geodesicLength(geometry: GeometryUnion, unit?: LinearUnits | number): number; /** * Creates new geometries from the intersections between two geometries. * * @param geometry1 The input geometry or array of geometries. * @param geometry2 The geometry to intersect with geometry1. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/intersectionOperator intersectionOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#intersect Read more...} */ intersect(geometry1: GeometryUnion | GeometryUnion[], geometry2: GeometryUnion): GeometryUnion | GeometryUnion[]; /** * Returns an array of points at the intersecting locations of two input polylines. * * @param line1 The first polyline to use in the intersect operation. * @param line2 The second polyline to use in the intersect operation. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/intersectionOperator#executeMany intersectionOperator's executeMany()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#intersectLinesToPoints Read more...} */ intersectLinesToPoints(line1: Polyline, line2: Polyline): Point[]; /** * Indicates if one geometry intersects another geometry. * * @param geometry1 The geometry that is tested for the intersects relationship to the other geometry. * @param geometry2 The geometry being intersected. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/intersectsOperator intersectsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#intersects Read more...} */ intersects(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * Indicates if the given geometry is non-OGC topologically simple. * * @param geometry The input geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/simplifyOperator#isSimple simplifyOperator's isSimple()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#isSimple Read more...} */ isSimple(geometry: GeometryUnion): boolean; /** * Finds the coordinate of the geometry that is closest to the specified point. * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest coordinate in the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestCoordinate proximityOperator's getNearestCoordinate()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestCoordinate Read more...} */ nearestCoordinate(geometry: GeometryUnion, inputPoint: Point): NearestPointResult; /** * Finds the vertex on the geometry nearest to the specified point. * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest vertex in the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestVertex proximityOperator's getNearestVertex()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestVertex Read more...} */ nearestVertex(geometry: GeometryUnion, 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. * * @param geometry The geometry to consider. * @param inputPoint The point from which to measure. * @param searchRadius The distance to search from the inputPoint in the units of the view's spatial reference. * @param maxVertexCountToReturn The maximum number of vertices to return. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestVertices proximityOperator's getNearestVertices()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestVertices Read more...} */ nearestVertices(geometry: GeometryUnion, 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. * * @param geometry The geometries to offset. * @param offsetDistance The planar distance to offset from the input geometry. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, if offsetDistance = 0, then there is no change in the geometries, otherwise it is constructed to the left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the "right side" of a simple polygon is always its inside. * @param offsetUnit Measurement unit of the offset distance. Defaults to the units of the input geometries. * @param joinType The join type. * @param bevelRatio Applicable when `joinType = 'miter'`; bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * @param flattenError Applicable when `joinType = 'round'`; flattenError determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/offsetOperator offsetOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#offset Read more...} */ offset(geometry: GeometryUnion | GeometryUnion[], offsetDistance: number, offsetUnit?: LinearUnits, joinType?: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): GeometryUnion | GeometryUnion[]; /** * Indicates if one geometry overlaps another geometry. * * @param geometry1 The base geometry that is tested for the "overlaps" relationship with the other geometry. * @param geometry2 The comparison geometry that is tested for the "overlaps" relationship with the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/overlapsOperator overlapsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#overlaps Read more...} */ overlaps(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * Calculates the area of the input geometry. * * @param geometry The input polygon. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/areaOperator areaOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#planarArea Read more...} */ planarArea(geometry: Polygon, unit?: AreaUnits): number; /** * Calculates the length of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/lengthOperator lengthOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#planarLength Read more...} */ planarLength(geometry: GeometryUnion, unit?: LinearUnits | number): number; /** * Indicates if the given DE-9IM relation is true for the two geometries. * * @param geometry1 The first geometry for the relation. * @param geometry2 The second geometry for the relation. * @param relation The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: `0`,`1`,`2`), a Boolean value (`T` or `F`), or a mask character (for ignoring results: '\*'). For example, each of the following DE-9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry: `TTTFFTFFT` (Boolean), 'T*\*\*\*\*\*FF\*' (ignore irrelevant intersections), or '102FF\*FF\*' (dimension form). Each returns the same result. See [this article](https://en.wikipedia.org/wiki/DE-9IM) for more information about the DE-9IM model and how string codes are constructed. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/relateOperator relateOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#relate Read more...} */ relate(geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): boolean; /** * Rotates a geometry counterclockwise by the specified number of degrees. * * @param geometry The geometry to rotate. * @param angle The rotation angle in degrees. * @param rotationOrigin Point to rotate the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#rotate Transformation's rotate()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#rotate Read more...} */ rotate(geometry: GeometryUnion, angle: number, rotationOrigin?: Point): GeometryUnion; /** * Performs the simplify operation on the geometry, which alters the given geometries to make their definitions * topologically legal with respect to their geometry type. * * @param geometry The geometry to be simplified. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/simplifyOperator simplifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#simplify Read more...} */ simplify(geometry: GeometryUnion): GeometryUnion; /** * Creates the symmetric difference of two geometries. * * @param leftGeometry One of the Geometry instances in the XOR operation. * @param rightGeometry One of the Geometry instances in the XOR operation. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/symmetricDifferenceOperator symmetricDifferenceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#symmetricDifference Read more...} */ symmetricDifference(leftGeometry: GeometryUnion | GeometryUnion[], rightGeometry: GeometryUnion): GeometryUnion | GeometryUnion[]; /** * Indicates if one geometry touches another geometry. * * @param geometry1 The geometry to test the "touches" relationship with the other geometry. * @param geometry2 The geometry to be touched. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/touchesOperator touchesOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#touches Read more...} */ touches(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; /** * All inputs must be of the same type of geometries and share one spatial reference. * * @param geometries An array of Geometries to union. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/unionOperator unionOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#union Read more...} */ union(geometries: GeometryUnion[]): GeometryUnion; /** * Indicates if one geometry is within another geometry. * * @param innerGeometry The base geometry that is tested for the "within" relationship to the other geometry. * @param outerGeometry The comparison geometry that is tested for the "contains" relationship to the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/withinOperator withinOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#within Read more...} */ within(innerGeometry: GeometryUnion, outerGeometry: GeometryUnion): boolean; } export const geometryEngine: geometryEngine; /** * Units for area measurements. * * @deprecated since version 4.32. Use {@link module:geoscene/core/units~AreaUnit AreaUnit} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#AreaUnits Read more...} */ export type AreaUnits = | "acres" | "ares" | "hectares" | "square-feet" | "square-meters" | "square-yards" | "square-kilometers" | "square-miles" | number; /** * Units for linear measurements. * * @deprecated since version 4.32. Use {@link module:geoscene/core/units~LengthUnit LengthUnit} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#LinearUnits Read more...} */ export type LinearUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards" | number; /** * Object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestCoordinate nearestCoordinate()}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestVertex nearestVertex()}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#nearestVertices nearestVertices()} methods. * * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator~ProximityResult proximityOperator's ProximityResult} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#NearestPointResult Read more...} */ export interface NearestPointResult { coordinate: Point; distance: number; vertexIndex: number; isEmpty: boolean; } /** * The return object of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#extendedSpatialReferenceInfo extendedSpatialReferenceInfo()} * method. * * @deprecated since version 4.32. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngine.html#SpatialReferenceInfo Read more...} */ export interface SpatialReferenceInfo { tolerance: number; unitBaseFactor: number; unitID: number; unitSquareDerivative: number; unitType: number; } /** * An asynchronous client-side geometry engine for testing, measuring, and analyzing the spatial relationship * between two or more 2D geometries. * * @deprecated since version 4.32. Use [geometry operators](../spatial-analysis/intro-geometry-operators/) instead. You can use the web workers to perform geometry operations in a separate thread, which can improve the performance. Options include using the SDK's {@link module:geoscene/core/workers worker} utility, creating a [custom worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers), or using a helper library such as [Comlink](https://github.com/GoogleChromeLabs/comlink?tab=readme-ov-file#comlink). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html Read more...} */ interface geometryEngineAsync { /** * Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries. * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. * @param unionResults Determines whether the output geometries should be unioned into a single polygon. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/bufferOperator bufferOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#buffer Read more...} */ buffer(geometry: GeometryUnion | GeometryUnion[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Promise; /** * Calculates the clipped geometry from a target geometry by an envelope. * * @param geometry The geometry to be clipped. * @param envelope The envelope used to clip. * @deprecated since version 4.32. {@link module:geoscene/geometry/operators/clipOperator clipOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#clip Read more...} */ clip(geometry: GeometryUnion, envelope: Extent): Promise; /** * Indicates if one geometry contains another geometry. * * @param containerGeometry The geometry that is tested for the "contains" relationship to the other geometry. Think of this geometry as the potential "container" of the `insideGeometry`. * @param insideGeometry The geometry that is tested for the "within" relationship to the `containerGeometry`. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/containsOperator containsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#contains Read more...} */ contains(containerGeometry: GeometryUnion, insideGeometry: GeometryUnion): Promise; /** * Calculates the convex hull of one or more geometries. * * @param geometry The input geometry or geometries used to calculate the convex hull. If an array is specified, the input array can include various geometry types. When an array is provided, the output will also be an array. * @param merge Indicates whether to merge the output into a single geometry (usually a polygon). * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/convexHullOperator convexHullOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#convexHull Read more...} */ convexHull(geometry: GeometryUnion | GeometryUnion[], merge?: boolean): Promise; /** * Indicates if one geometry crosses another geometry. * * @param geometry1 The geometry to cross. * @param geometry2 The geometry being crossed. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/crossesOperator crossesOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#crosses Read more...} */ crosses(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * Split the input Polyline or Polygon where it crosses a cutting Polyline. * * @param geometry The geometry to be cut. * @param cutter The polyline to cut the geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/cutOperator cutOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#cut Read more...} */ cut(geometry: GeometryUnion, cutter: Polyline): Promise; /** * Densify geometries by plotting points between existing vertices. * * @param geometry The geometry to be densified. * @param maxSegmentLength The maximum segment length allowed. Must be a positive value. * @param maxSegmentLengthUnit Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/densifyOperator densifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#densify Read more...} */ densify(geometry: GeometryUnion, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Promise; /** * Creates the difference of two geometries. * * @param inputGeometry The input geometry to subtract from. * @param subtractor The geometry being subtracted from inputGeometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/differenceOperator differenceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#difference Read more...} */ difference(inputGeometry: GeometryUnion | GeometryUnion[], subtractor: GeometryUnion): Promise; /** * Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry. * * @param geometry1 The base geometry that is tested for the "disjoint" relationship to the other geometry. * @param geometry2 The comparison geometry that is tested for the "disjoint" relationship to the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/disjointOperator disjointOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#disjoint Read more...} */ disjoint(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * Calculates the shortest planar distance between two geometries. * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @param distanceUnit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/distanceOperator distanceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#distance Read more...} */ distance(geometry1: GeometryUnion, geometry2: GeometryUnion, distanceUnit?: LinearUnits): Promise; /** * Indicates if two geometries are equal. * * @param geometry1 First input geometry. * @param geometry2 Second input geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/equalsOperator equalsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#equals Read more...} */ equals(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * Returns an object containing additional information about the input spatial reference. * * @param spatialReference The input spatial reference. * @deprecated since version 4.32. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#extendedSpatialReferenceInfo Read more...} */ extendedSpatialReferenceInfo(spatialReference: SpatialReference): Promise; /** * Flips a geometry on the horizontal axis. * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#flipY Transformation's flipY()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#flipHorizontal Read more...} */ flipHorizontal(geometry: GeometryUnion, flipOrigin?: Point | null): Promise; /** * Flips a geometry on the vertical axis. * * @param geometry The input geometry to be flipped. * @param flipOrigin Point to flip the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#flipX Transformation's flipX()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#flipVertical Read more...} */ flipVertical(geometry: GeometryUnion, flipOrigin?: Point | null): Promise; /** * Performs the generalize operation on the geometries in the cursor. * * @param geometry The input geometry to be generalized. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. * @param removeDegenerateParts When `true` the degenerate parts of the geometry will be removed from the output (may be undesired for drawing). * @param maxDeviationUnit Measurement unit for maxDeviation. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/generalizeOperator generalizeOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#generalize Read more...} */ generalize(geometry: GeometryUnion, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: LinearUnits): Promise; /** * Calculates the area of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticAreaOperator geodeticAreaOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#geodesicArea Read more...} */ geodesicArea(geometry: GeometryUnion, unit?: AreaUnits | number): Promise; /** * Creates geodesic buffer polygons at a specified distance around the input geometries. * * @param geometry The buffer input geometry. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. * @param distance The specified distance(s) for buffering. The `geometry` and `distance` parameters must be specified as either both arrays or both non-arrays. Never specify one as an array and the other a non-array. When using an array of geometries as input, the length of the geometry array does not have to equal the length of the `distance` array. For example, if you pass an array of four geometries: `[g1, g2, g3, g4]` and an array with one distance: `[d1]`, all four geometries will be buffered by the single distance value. If instead you use an array of three distances: `[d1, d2, d3]`, `g1` will be buffered by `d1`, `g2` by `d2`, and `g3` and `g4` will both be buffered by `d3`. The value of the geometry array will be matched one to one with those in the distance array until the final value of the distance array is reached, in which case that value will be applied to the remaining geometries. * @param unit Measurement unit of the distance(s). Defaults to the units of the input geometries. * @param unionResults Determines whether the output geometries should merge into a single polygon. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodesicBufferOperator geodesicBufferOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#geodesicBuffer Read more...} */ geodesicBuffer(geometry: GeometryUnion | GeometryUnion[], distance: number | number[], unit?: LinearUnits, unionResults?: boolean): Promise; /** * Returns a geodetically densified version of the input geometry. * * @param geometry A geometry to densify. * @param maxSegmentLength The maximum segment length allowed (in meters if a `maxSegmentLengthUnit` is not provided). This must be a positive value. * @param maxSegmentLengthUnit Measurement unit for `maxSegmentLength`. If not provided, the unit will default to `meters`. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticDensifyOperator geodeticDensifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#geodesicDensify Read more...} */ geodesicDensify(geometry: GeometryUnion, maxSegmentLength: number, maxSegmentLengthUnit?: LinearUnits): Promise; /** * Calculates the length of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/geodeticLengthOperator geodeticLengthOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#geodesicLength Read more...} */ geodesicLength(geometry: GeometryUnion, unit?: LinearUnits): Promise; /** * Creates new geometries from the intersections between two geometries. * * @param geometry1 The input geometry or array of geometries. * @param geometry2 The geometry to intersect with geometry1. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/intersectionOperator intersectionOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#intersect Read more...} */ intersect(geometry1: GeometryUnion | GeometryUnion[], geometry2: GeometryUnion): Promise; /** * Resolves to an array of points at the intersecting locations of two input polylines. * * @param line1 The first polyline to use in the intersect operation. * @param line2 The second polyline to use in the intersect operation. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/intersectionOperator#executeMany intersectionOperator's executeMany()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#intersectLinesToPoints Read more...} */ intersectLinesToPoints(line1: Polyline, line2: Polyline): Promise; /** * Indicates if one geometry intersects another geometry. * * @param geometry1 The geometry that is tested for the intersects relationship to the other geometry. * @param geometry2 The geometry being intersected. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/intersectsOperator intersectsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#intersects Read more...} */ intersects(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * Indicates if the given geometry is non-OGC topologically simple. * * @param geometry The input geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/simplifyOperator#isSimple simplifyOperator's isSimple()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#isSimple Read more...} */ isSimple(geometry: GeometryUnion): Promise; /** * Finds the coordinate of the geometry that is closest to the specified point. * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest coordinate in the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestCoordinate proximityOperator's getNearestCoordinate()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#nearestCoordinate Read more...} */ nearestCoordinate(geometry: GeometryUnion, inputPoint: Point): Promise; /** * Finds vertex on the geometry nearest to the specified point. * * @param geometry The geometry to consider. * @param inputPoint The point used to search the nearest vertex in the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestVertex proximityOperator's getNearestVertex()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#nearestVertex Read more...} */ nearestVertex(geometry: GeometryUnion, 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. * * @param geometry The geometry to consider. * @param inputPoint The point from which to measure. * @param searchRadius The distance to search from the inputPoint in the units of the view's spatial reference. * @param maxVertexCountToReturn The maximum number of vertices to return. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/proximityOperator#getNearestVertices proximityOperator's getNearestVertices()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#nearestVertices Read more...} */ nearestVertices(geometry: GeometryUnion, 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. * * @param geometry The geometries to offset. * @param offsetDistance The planar distance to offset from the input geometry. If offsetDistance > 0, then the offset geometry is constructed to the right of the oriented input geometry, if offsetDistance = 0, then there is no change in the geometries, otherwise it is constructed to the left. For a simple polygon, the orientation of outer rings is clockwise and for inner rings it is counter clockwise. So the "right side" of a simple polygon is always its inside. * @param offsetUnit Measurement unit of the offset distance. Defaults to the units of the input geometries. * @param joinType The join type. * @param bevelRatio Applicable when `joinType = 'miter'`; bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. * @param flattenError Applicable when `joinType = 'round'`; flattenError determines the maximum distance of the resulting segments compared to the true circular arc. The algorithm never produces more than around 180 vertices for each round join. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/offsetOperator offsetOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#offset Read more...} */ offset(geometry: GeometryUnion | GeometryUnion[], offsetDistance: number, offsetUnit?: LinearUnits, joinType?: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): Promise; /** * Indicates if one geometry overlaps another geometry. * * @param geometry1 The base geometry that is tested for the "overlaps" relationship with the other geometry. * @param geometry2 The comparison geometry that is tested for the "overlaps" relationship with the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/overlapsOperator overlapsOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#overlaps Read more...} */ overlaps(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * Calculates the area of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/areaOperator areaOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#planarArea Read more...} */ planarArea(geometry: GeometryUnion, unit?: AreaUnits | number): Promise; /** * Calculates the length of the input geometry. * * @param geometry The input geometry. * @param unit Measurement unit of the return value. Defaults to the units of the input geometries. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/lengthOperator lengthOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#planarLength Read more...} */ planarLength(geometry: GeometryUnion, unit?: LinearUnits): Promise; /** * Indicates if the given DE-9IM relation holds for the two geometries. * * @param geometry1 The first geometry for the relation. * @param geometry2 The second geometry for the relation. * @param relation The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to test against the relationship of the two geometries. This string contains the test result of each intersection represented in the DE-9IM matrix. Each result is one character of the string and may be represented as either a number (maximum dimension returned: `0`,`1`,`2`), a Boolean value (`T` or `F`), or a mask character (for ignoring results: '\*'). For example, each of the following DE-9IM string codes are valid for testing whether a polygon geometry completely contains a line geometry: `TTTFFTFFT` (Boolean), 'T\*\*\*\*\*FF\*' (ignore irrelevant intersections), or '102FF\*FF\*' (dimension form). Each returns the same result. See [this article](https://en.wikipedia.org/wiki/DE-9IM) for more information about the DE-9IM model and how string codes are constructed. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/relateOperator relateOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#relate Read more...} */ relate(geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): Promise; /** * Rotates a geometry counterclockwise by the specified number of degrees. * * @param geometry The geometry to rotate. * @param angle The rotation angle in degrees. * @param rotationOrigin Point to rotate the geometry around. Defaults to the centroid of the geometry. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/support/Transformation#rotate Transformation's rotate()} method and the {@link module:geoscene/geometry/operators/affineTransformationOperator affineTransformationOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#rotate Read more...} */ rotate(geometry: GeometryUnion, angle: number, rotationOrigin?: Point | nullish): 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. * * @param geometry The geometry to be simplified. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/simplifyOperator simplifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#simplify Read more...} */ simplify(geometry: GeometryUnion): Promise; /** * Creates the symmetric difference of two geometries. * * @param leftGeometry One of the Geometry instances in the XOR operation. * @param rightGeometry One of the Geometry instances in the XOR operation. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/symmetricDifferenceOperator symmetricDifferenceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#symmetricDifference Read more...} */ symmetricDifference(leftGeometry: GeometryUnion | GeometryUnion[], rightGeometry: GeometryUnion): Promise; /** * Indicates if one geometry touches another geometry. * * @param geometry1 The geometry to test the "touches" relationship with the other geometry. * @param geometry2 The geometry to be touched. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/touchesOperator touchesOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#touches Read more...} */ touches(geometry1: GeometryUnion, geometry2: GeometryUnion): Promise; /** * All inputs must be of the same type of geometries and share one spatial reference. * * @param geometries An array of Geometries to union. * @deprecated since 4.32. Use {@link module:geoscene/geometry/operators/unionOperator unionOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#union Read more...} */ union(geometries: GeometryUnion[]): Promise; /** * Indicates if one geometry is within another geometry. * * @param innerGeometry The base geometry that is tested for the "within" relationship to the other geometry. * @param outerGeometry The comparison geometry that is tested for the "contains" relationship to the other geometry. * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/withinOperator withinOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#within Read more...} */ within(innerGeometry: GeometryUnion, outerGeometry: GeometryUnion): Promise; } export const geometryEngineAsync: geometryEngineAsync; /** * The return object of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#extendedSpatialReferenceInfo extendedSpatialReferenceInfo()} * method. * * @deprecated since version 4.32. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-geometryEngineAsync.html#SpatialReferenceInfo Read more...} */ export interface geometryEngineAsyncSpatialReferenceInfo { tolerance: number; unitBaseFactor: number; unitID: number; unitSquareDerivative: number; 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#heightModel Read more...} */ readonly heightModel: "gravity-related-height" | "ellipsoidal"; /** * The unit of the vertical coordinate system. * * @default "meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#heightUnit Read more...} */ readonly heightUnit: | "150-kilometers" | "1865-feet" | "50-kilometers" | "benoit-1895-a-chains" | "benoit-1895-a-feet" | "benoit-1895-a-links" | "benoit-1895-a-yards" | "benoit-1895-b-chains" | "benoit-1895-b-feet" | "benoit-1895-b-links" | "benoit-1895-b-yards" | "british-1936-feet" | "centimeters" | "chains" | "clarke-chains" | "clarke-feet" | "clarke-links" | "clarke-yards" | "decimeters" | "fathoms" | "feet" | "german-meters" | "gold-coast-feet" | "inches" | "indian-1937-feet" | "indian-1937-yards" | "indian-1962-feet" | "indian-1962-yards" | "indian-1975-feet" | "indian-1975-yards" | "indian-feet" | "indian-yards" | "kilometers" | "links" | "meters" | "micrometers" | "millimeters" | "nanometers" | "nautical-miles" | "points" | "rods" | "sears-1922-truncated-chains" | "sears-1922-truncated-feet" | "sears-1922-truncated-links" | "sears-1922-truncated-yards" | "sears-chains" | "sears-feet" | "sears-links" | "sears-yards" | "smoots" | "statute-miles" | "tx-vara" | "uk-nautical-miles" | "us-chains" | "us-feet" | "us-inches" | "us-links" | "us-miles" | "us-nautical-miles" | "us-rods" | "us-yards" | "yards"; /** * The datum realization of the vertical coordinate system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#vertCRS Read more...} */ readonly vertCRS: string | nullish; /** * The height model info defines the characteristics of a vertical coordinate system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html Read more...} */ constructor(properties?: HeightModelInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): HeightModelInfo; } interface HeightModelInfoProperties { /** * The surface type or height model of the vertical coordinate system (VCS). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#heightModel Read more...} */ heightModel?: "gravity-related-height" | "ellipsoidal"; /** * The unit of the vertical coordinate system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#heightUnit Read more...} */ heightUnit?: | "150-kilometers" | "1865-feet" | "50-kilometers" | "benoit-1895-a-chains" | "benoit-1895-a-feet" | "benoit-1895-a-links" | "benoit-1895-a-yards" | "benoit-1895-b-chains" | "benoit-1895-b-feet" | "benoit-1895-b-links" | "benoit-1895-b-yards" | "british-1936-feet" | "centimeters" | "chains" | "clarke-chains" | "clarke-feet" | "clarke-links" | "clarke-yards" | "decimeters" | "fathoms" | "feet" | "german-meters" | "gold-coast-feet" | "inches" | "indian-1937-feet" | "indian-1937-yards" | "indian-1962-feet" | "indian-1962-yards" | "indian-1975-feet" | "indian-1975-yards" | "indian-feet" | "indian-yards" | "kilometers" | "links" | "meters" | "micrometers" | "millimeters" | "nanometers" | "nautical-miles" | "points" | "rods" | "sears-1922-truncated-chains" | "sears-1922-truncated-feet" | "sears-1922-truncated-links" | "sears-1922-truncated-yards" | "sears-chains" | "sears-feet" | "sears-links" | "sears-yards" | "smoots" | "statute-miles" | "tx-vara" | "uk-nautical-miles" | "us-chains" | "us-feet" | "us-inches" | "us-links" | "us-miles" | "us-nautical-miles" | "us-rods" | "us-yards" | "yards"; /** * The datum realization of the vertical coordinate system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-HeightModelInfo.html#vertCRS Read more...} */ vertCRS?: string | nullish; } export interface Mesh extends Geometry, Loadable { } export class Mesh { /** * The 3D extent of the mesh geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#extent Read more...} */ readonly extent: Extent; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The origin of the mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#origin Read more...} */ readonly origin: Point; /** * The string value representing the type of geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#type Read more...} */ readonly type: "mesh"; /** * A mesh is a general, client-side 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html geometry} type * composed of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributes vertices with attributes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html Read more...} */ constructor(properties?: MeshProperties); /** * An array of mesh components that can be used to apply materials * to different regions of the same mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#components Read more...} */ get components(): MeshComponent[] | nullish; set components(value: MeshComponentProperties[] | nullish); /** * Additional local transformation of the mesh vertices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#transform Read more...} */ get transform(): MeshTransform | nullish; set transform(value: MeshTransformProperties | nullish); /** * Object describing the attributes of each vertex of the mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributes Read more...} */ get vertexAttributes(): MeshVertexAttributes; set vertexAttributes(value: MeshVertexAttributesProperties); /** * The vertex space of the mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexSpace Read more...} */ get vertexSpace(): MeshGeoreferencedVertexSpace | MeshLocalVertexSpace; set vertexSpace(value: | (MeshGeoreferencedVertexSpaceProperties & { type: "georeferenced" }) | (MeshLocalVertexSpaceProperties & { type: "local" })); /** * Adds a component to the mesh. * * @param component The component to add. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#addComponent Read more...} */ addComponent(component: MeshComponentProperties): void; /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Centers the mesh at the specified location without changing its scale. * * @param location The location at which to center the mesh. * @param parameters Additional parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#centerAt Read more...} */ centerAt(location: Point, parameters?: MeshCenterAtParameters): Mesh; /** * Creates a deep clone of the Mesh object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#clone Read more...} */ clone(): Mesh; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Offsets the mesh geometry by the specified distance in x, y, and z. * * @param dx The amount to offset the geometry in the x direction. * @param dy The amount to offset the geometry in the y direction. * @param dz The amount to offset the geometry in the z direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#offset Read more...} */ offset(dx: number, dy: number, dz: number): Mesh; /** * Removes a component from the mesh. * * @param component The component to remove. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#removeComponent Read more...} */ removeComponent(component: MeshComponent): void; /** * Rotates the mesh geometry around its x, y and z axis (in that order). * * @param angleX The angle by which to rotate around the x-axis (in degrees). * @param angleY The angle by which to rotate around the y-axis (in degrees). * @param angleZ The angle by which to rotate around the z-axis (in degrees). * @param parameters Additional parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#rotate Read more...} */ rotate(angleX: number, angleY: number, angleZ: number, parameters?: MeshRotateParameters): Mesh; /** * Scales the mesh geometry by the specified factor. * * @param factor The amount to scale the geometry. * @param parameters Additional parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#scale Read more...} */ scale(factor: number, parameters?: MeshScaleParameters): Mesh; /** * Export a mesh to a binary glTF (glb) representation. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#toBinaryGLTF Read more...} */ toBinaryGLTF(options?: MeshToBinaryGLTFOptions): Promise; /** * Notifies that any cached values that depend on vertex attributes need to be recalculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributesChanged Read more...} */ vertexAttributesChanged(): void; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a mesh representing a box. * * @param location The location bottom center of the box. * @param parameters Parameters to configure the box creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createBox Read more...} */ static createBox(location: Point, parameters?: CreateBoxParameters): Mesh; /** * Creates a mesh representing a cylinder. * * @param location The location of the bottom center of the cylinder. * @param parameters Parameters to configure the cylinder creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createCylinder Read more...} */ static createCylinder(location: Point, parameters?: CreateCylinderParameters): Mesh; /** * Creates a new mesh geometry from a glTF model referenced by the `url` parameter. * * @param location The location of the origin of the model. If the location doesn't contain a z-value, z is assumed to be `0`. * @param url The URL of the glTF model. The URL should point to a glTF file (.gltf or .glb) which can reference additional binary (.bin) and image files (.jpg, .png). * @param parameters Parameters to configure the mesh from gltf creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createFromGLTF Read more...} */ static createFromGLTF(location: Point, url: string, parameters?: CreateFromGLTFParameters): Promise; /** * Creates a new mesh geometry from a polygon geometry. * * @param polygon The input polygon. * @param parameters Optional parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createFromPolygon Read more...} */ static createFromPolygon(polygon: Polygon, parameters?: MeshCreateFromPolygonParameters): Mesh; /** * Creates a mesh representing a plane. * * @param location The location of the bottom center of the plane. * @param parameters Parameters to configure the plane creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createPlane Read more...} */ static createPlane(location: Point, parameters?: CreatePlaneParameters): Mesh; /** * Creates a mesh representing a sphere. * * @param location The location of the bottom center of the sphere. * @param parameters Parameters to configure the sphere creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#createSphere Read more...} */ static createSphere(location: Point, parameters?: 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#components Read more...} */ components?: MeshComponentProperties[] | nullish; /** * Additional local transformation of the mesh vertices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#transform Read more...} */ transform?: MeshTransformProperties | nullish; /** * Object describing the attributes of each vertex of the mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributes Read more...} */ vertexAttributes?: MeshVertexAttributesProperties; /** * The vertex space of the mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexSpace Read more...} */ vertexSpace?: | (MeshGeoreferencedVertexSpaceProperties & { type: "georeferenced" }) | (MeshLocalVertexSpaceProperties & { type: "local" }); } /** * Parameters used to configure box mesh creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#CreateBoxParameters Read more...} */ export interface CreateBoxParameters { size?: number | CreateBoxParametersSize; unit?: LengthUnit; vertexSpace?: "local" | "georeferenced"; material?: MeshMaterial; imageFace?: "east" | "west" | "north" | "south" | "up" | "down"; } /** * Parameters used to configure cylinder mesh creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#CreateCylinderParameters Read more...} */ export interface CreateCylinderParameters { size?: number | any; width?: number; depth?: number; height?: number; unit?: LengthUnit; densificationFactor?: number; vertexSpace?: "local" | "georeferenced"; material?: MeshMaterial; } /** * Parameters used to configure gltf mesh creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#CreateFromGLTFParameters Read more...} */ export interface CreateFromGLTFParameters { signal?: AbortSignal | nullish; vertexSpace?: "local" | "georeferenced"; material?: MeshMaterial; } /** * Parameters used to configure plane mesh creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#CreatePlaneParameters Read more...} */ export interface CreatePlaneParameters { size?: number | any; width?: number; depth?: number; height?: number; facing?: "east" | "west" | "north" | "south" | "up" | "down"; unit?: LengthUnit; densificationFactor?: number; vertexSpace?: "local" | "georeferenced"; material?: MeshMaterial; } /** * Parameters used to configure sphere mesh creation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#CreateSphereParameters Read more...} */ export interface CreateSphereParameters { size?: number | any; width?: number; depth?: number; height?: number; unit?: LengthUnit; densificationFactor?: number; vertexSpace?: "local" | "georeferenced"; material?: MeshMaterial; } export interface MeshCenterAtParameters { geographic?: boolean; origin?: Point; } export interface MeshCreateFromPolygonParameters { material?: MeshMaterialProperties; } export interface MeshRotateParameters { geographic?: boolean; origin?: Point; } export interface MeshScaleParameters { geographic?: boolean; origin?: Point; } export interface MeshToBinaryGLTFOptions { origin?: Point; signal?: AbortSignal | nullish; } export interface MeshVertexAttributesProperties { position?: Float64Array | number[] | Float32Array; uv?: Float32Array | nullish | number[] | Float64Array; normal?: Float32Array | nullish | number[] | Float64Array; color?: Uint8Array | nullish | number[] | Uint8ClampedArray; tangent?: Float32Array | nullish | number[] | Float64Array; } export interface MeshVertexAttributes extends AnonymousAccessor { get position(): Float64Array; set position(value: Float64Array | number[] | Float32Array); get uv(): Float32Array | nullish; set uv(value: Float32Array | nullish | number[] | Float64Array); get normal(): Float32Array | nullish; set normal(value: Float32Array | nullish | number[] | Float64Array); get color(): Uint8Array | nullish; set color(value: Uint8Array | nullish | number[] | Uint8ClampedArray); get tangent(): Float32Array | nullish; set tangent(value: Float32Array | nullish | number[] | Float64Array); } export interface CreateBoxParametersSize { width?: number; depth?: number; height?: number; } export class Multipoint extends Geometry { /** * An array of points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#points Read more...} */ points: number[][]; /** * The string value representing the type of geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#type Read more...} */ readonly type: "multipoint"; /** * An ordered collection of points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html Read more...} */ constructor(properties?: MultipointProperties); /** * Adds a point to the Multipoint. * * @param point The point to add to the multipoint. The point can either be a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} or an array of numbers representing XY coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#addPoint Read more...} */ addPoint(point: Point | number[]): Multipoint; /** * Creates a deep clone of Multipoint object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#clone Read more...} */ clone(): Multipoint; /** * Returns the point at the specified index. * * @param index The index of the point in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#points points} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#getPoint Read more...} */ getPoint(index: number): Point | nullish; /** * Removes a point from the Multipoint. * * @param index The index of the point to remove. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#removePoint Read more...} */ removePoint(index: number): Point | nullish; /** * Updates the point at the specified index. * * @param index The index of the point in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#points points} property. * @param point Point geometry that specifies the new location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#setPoint Read more...} */ setPoint(index: number, point: Point | number[]): Multipoint; static fromJSON(json: any): Multipoint; } interface MultipointProperties extends GeometryProperties { /** * An array of points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html#points Read more...} */ points?: number[][]; } /** * Applies an affine transformation to 2D geometries via the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html Transformation} class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-affineTransformOperator.html Read more...} */ interface affineTransformOperator { readonly supportsCurves: boolean; /** * Executes an affine transformation on the geometry. * * @param geometry The geometry to be transformed. * @param transformation The transformation to apply to the `geometry`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-affineTransformOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, transformation: Transformation): GeometryUnion; /** * Executes an affine transformation on multiple geometries. * * @param geometries The geometries to be transformed. All the geometries must have the same spatial reference. * @param transformation The transformation to apply to the `geometries`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-affineTransformOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], transformation: Transformation): GeometryUnion[]; } export const affineTransformOperator: affineTransformOperator; /** * Calculates the alpha shape of 2D points (concave hull). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-alphaShapeOperator.html Read more...} */ interface alphaShapeOperator { readonly supportsCurves: boolean; /** * Calculates the alpha shape on the input geometry. * * @param geometry The input geometry. Only geometry vertices are used to compute the alpha shape. * @param alpha Controls the level of detail and concavity of the boundary. The value represents the square of the alpha radius for the alpha shape. Values of 0.0 or small positive numbers will yield an empty alpha shape. A negative number or NaN will lead to the alpha shape being computed with the minimal alpha value necessary to produce a connected result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-alphaShapeOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, alpha: number): ExecuteResult; /** * Calculates the alpha shape on a set of geometries with the option to aggregate the result. * * @param geometries The input geometries. Only geometry vertices are used to compute the alpha shape. All the geometries must have the same spatial reference. * @param alpha Controls the level of detail and concavity of the boundary. The value represents the square of the alpha radius for the alpha shape. Values of 0.0 or small positive numbers will yield an empty alpha shape. A negative number or NaN will lead to the alpha shape being computed with the minimal alpha value necessary to produce a connected result. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-alphaShapeOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], alpha: number, options?: alphaShapeOperatorExecuteManyOptions): (Polygon | nullish)[]; } export const alphaShapeOperator: alphaShapeOperator; export interface alphaShapeOperatorExecuteManyOptions { merge?: boolean; } /** * Object returned by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-alphaShapeOperator.html#executeMany executeMany()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-alphaShapeOperator.html#ExecuteResult Read more...} */ export interface ExecuteResult { alphaShape: Polygon; calculatedAlpha: number; } /** * Returns the planar area of a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-areaOperator.html Read more...} */ interface areaOperator { readonly supportsCurves: boolean; /** * Calculates the planar area of the input geometry. * * @param geometry The geometry to calculate the area from. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-areaOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, options?: areaOperatorExecuteOptions): number; } export const areaOperator: areaOperator; export interface areaOperatorExecuteOptions { unit?: AreaUnit; } /** * Fills the closed gaps between 2D polygons using polygon boundaries and polylines as the boundary for creating new polygons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-autoCompleteOperator.html Read more...} */ interface autoCompleteOperator { readonly supportsCurves: boolean; /** * Fills the gaps between polygons using the polylines as additional boundaries. * * @param polygons The polygons to fill. * @param polylines The polylines to use as boundaries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-autoCompleteOperator.html#execute Read more...} */ execute(polygons: Polygon[], polylines: Polyline[]): Polygon[]; } export const autoCompleteOperator: autoCompleteOperator; /** * Calculates the topological boundary of a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-boundaryOperator.html Read more...} */ interface boundaryOperator { readonly supportsCurves: boolean; /** * Calculates the boundary on the input geometry. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-boundaryOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): GeometryUnion | nullish; /** * Calculates the boundaries on a set of geometries. * * @param geometries The input geometries. All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-boundaryOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): (GeometryUnion | nullish)[]; } export const boundaryOperator: boundaryOperator; /** * Creates planar buffers around 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-bufferOperator.html Read more...} */ interface bufferOperator { readonly supportsCurves: boolean; /** * Creates a buffer around the input geometry. * * @param geometry The input geometry to be buffered. * @param distance The buffer distance for the geometry. Unless the `unit` option is set, the default is the geometry's spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-bufferOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, distance: number, options?: bufferOperatorExecuteOptions): Polygon | nullish; /** * Creates a buffer around the input geometries. * * @param geometries The input geometries to be buffered. All the geometries must have the same spatial reference. * @param distances The buffer distances for the geometries. If the size of this array is less than the number of geometries in the input `geometries`, the last distance value is used for the rest of geometries. Unless the `unit` option is set, the default is the geometries spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-bufferOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], distances: number[], options?: bufferOperatorExecuteManyOptions): Polygon[]; } export const bufferOperator: bufferOperator; export interface bufferOperatorExecuteManyOptions { maxDeviation?: number; maxVerticesInFullCircle?: number; union?: boolean; unit?: LengthUnit; } export interface bufferOperatorExecuteOptions { unit?: LengthUnit; } /** * Calculates the centroid for a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-centroidOperator.html Read more...} */ interface centroidOperator { readonly supportsCurves: boolean; /** * Performs the centroid operation on a geometry. * * @param geometry The geometry in which to calculate the centroid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-centroidOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): Point; } export const centroidOperator: centroidOperator; /** * Clips geometries with a 2D extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-clipOperator.html Read more...} */ interface clipOperator { readonly supportsCurves: boolean; /** * Perform the clip operation on the input geometry. * * @param geometry The geometry to be clipped. * @param extent The extent used to clip the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-clipOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, extent: Extent): GeometryUnion | nullish; /** * Perform the clip operation on the input geometries. * * @param geometries The array of geometries to be clipped. All the geometries must have the same spatial reference. * @param extent The extent used to clip the geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-clipOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], extent: Extent): (GeometryUnion | nullish)[]; } export const clipOperator: clipOperator; /** * Performs a relational operation to determine if one 2D geometry contains another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-containsOperator.html Read more...} */ interface containsOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-containsOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform the contains operation on two geometries. * * @param geometry1 The geometry that is tested for the "contains" relationship to `geometry2`. * @param geometry2 The geometry that is tested for the "within" relationship to `geometry1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-containsOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const containsOperator: containsOperator; /** * Calculates the convex hull of 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-convexHullOperator.html Read more...} */ interface convexHullOperator { readonly supportsCurves: boolean; /** * Calculates the convex hull geometry. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-convexHullOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): GeometryUnion | nullish; /** * Calculates the convex hull. * * @param geometries The input geometries. All the geometries must have the same spatial reference. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-convexHullOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], options?: convexHullOperatorExecuteManyOptions): (GeometryUnion | nullish)[]; /** * Checks if a geometry is convex. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-convexHullOperator.html#isConvex Read more...} */ isConvex(geometry: GeometryUnion): boolean; } export const convexHullOperator: convexHullOperator; export interface convexHullOperatorExecuteManyOptions { merge?: boolean; } /** * Performs a relational operation to determine if one 2D geometry crosses another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-crossesOperator.html Read more...} */ interface crossesOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-crossesOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform the crosses operation on two geometries. * * @param geometry1 The geometry to cross. * @param geometry2 The geometry being crossed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-crossesOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const crossesOperator: crossesOperator; /** * Cut 2D geometries with a polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-cutOperator.html Read more...} */ interface cutOperator { readonly supportsCurves: boolean; /** * Performs the cut operation on a geometry. * * @param geometry The input geometry to be cut. * @param polyline The polyline that will be used to divide the input `geometry` into pieces where they cross the `polyline`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-cutOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, polyline: Polyline): GeometryUnion[]; } export const cutOperator: cutOperator; /** * Densifies 2D geometries by length, deviation and/or angle in a 2D plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-densifyOperator.html Read more...} */ interface densifyOperator { readonly supportsCurves: boolean; /** * Performs the densify operation on the geometry. * * @param geometry The geometry to be densified. * @param maxSegmentLength The maximum distance between vertices when the input geometry is densified. The number must be greater than or equal to zero. When the parameter is set to `0`, this operation only applies to curves and disables densification by length. Curves are densified to straight segments using the given length. And, curves are split into shorter subcurves such that the length of subcurves is shorter than `maxSegmentLength`. After that the curves are replaced with straight segments. Unless the `unit` option is set, the default is the spatial reference unit of `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-densifyOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, maxSegmentLength: number, options?: densifyOperatorExecuteOptions): GeometryUnion; /** * Performs the Densify operation on the geometry set. * * @param geometries The set of geometries to be densified. All the geometries must have the same spatial reference. * @param maxSegmentLength The maximum segment length allowed. The number must be greater than or equal to zero. When the parameter is set to `0`, this operation only applies to curves and disables densification by length. Curves are densified to straight segments using the given length. And, curves are split into shorter subcurves such that the length of subcurves is shorter than `maxSegmentLength`. After that the curves are replaced with straight segments. Unless the `unit` option is set, the default is the geometries spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-densifyOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], maxSegmentLength: number, options?: densifyOperatorExecuteManyOptions): GeometryUnion[]; } export const densifyOperator: densifyOperator; export interface densifyOperatorExecuteManyOptions { maxAngleInDegrees?: number; maxDeviation?: number; unit?: LengthUnit; } export interface densifyOperatorExecuteOptions { maxAngleInDegrees?: number; maxDeviation?: number; unit?: LengthUnit; } /** * Performs a topological difference operation on 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-differenceOperator.html Read more...} */ interface differenceOperator { readonly supportsCurves: boolean; /** * Performs the topological difference operation on the two geometries. * * @param geometry The geometry instance on the left hand side of the subtraction. * @param subtractor The geometry on the right hand side being subtracted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-differenceOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, subtractor: GeometryUnion): GeometryUnion | nullish; /** * Performs the Topological difference operation on the geometry set. * * @param geometries The set of geometry instance to be subtracted by the `subtractor`. All the geometries must have the same spatial reference. * @param subtractor The geometry on the right hand side being subtracted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-differenceOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], subtractor: GeometryUnion): (GeometryUnion | nullish)[]; } export const differenceOperator: differenceOperator; /** * Performs a relational operation to determine if one 2D geometry is disjoint (doesn't intersect in any way) with another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-disjointOperator.html Read more...} */ interface disjointOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-disjointOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform a disjoint operation on two geometries. * * @param geometry1 The base geometry that is tested for the "disjoint" relationship with `geometry2`. * @param geometry2 The comparison geometry that is tested for the "disjoint" relationship with `geometry1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-disjointOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const disjointOperator: disjointOperator; /** * Calculates planar distance between 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-distanceOperator.html Read more...} */ interface distanceOperator { readonly supportsCurves: boolean; /** * Returns the planar distance between two geometries. * * @param geometry1 The first input geometry. * @param geometry2 The second input geometry. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-distanceOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion, options?: distanceOperatorExecuteOptions): number; } export const distanceOperator: distanceOperator; export interface distanceOperatorExecuteOptions { unit?: LengthUnit; } /** * Performs a relational operation to determine if two 2D geometries are topologically equal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-equalsOperator.html Read more...} */ interface equalsOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-equalsOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform the equals operation on two geometries. * * @param geometry1 The first geometry. * @param geometry2 The second geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-equalsOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const equalsOperator: equalsOperator; /** * Extend 2D polylines with a polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-extendOperator.html Read more...} */ interface extendOperator { readonly supportsCurves: boolean; /** * Performs the extend operation on a polyline using a polyline as the extender. * * @param polyline1 The polyline to be extended. * @param polyline2 The polyline to extend to. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-extendOperator.html#execute Read more...} */ execute(polyline1: Polyline, polyline2: Polyline, options?: extendOperatorExecuteOptions): Polyline | nullish; } export const extendOperator: extendOperator; export interface extendOperatorExecuteOptions { relocateEnds?: boolean; keepEndAttributes?: boolean; noEndAttributes?: boolean; noExtendAtFrom?: boolean; noExtendAtTo?: boolean; } /** * Generalizes 2D geometries using Douglas-Peucker algorithm. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-generalizeOperator.html Read more...} */ interface generalizeOperator { readonly supportsCurves: boolean; /** * Performs the generalize operation on the input geometry. * * @param geometry The input geometry to be generalized. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. If maxDeviation <= 0 the operator returns the input geometry. Unless the `unit` option is set, the default is the spatial reference unit of `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-generalizeOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, maxDeviation: number, options?: generalizeOperatorExecuteOptions): GeometryUnion | nullish; /** * Performs the generalize operation on the input geometries. * * @param geometries The input geometries to be generalized. All the geometries must have the same spatial reference. * @param maxDeviation The maximum allowed deviation from the generalized geometry to the original geometry. If the value is less than or equal to zero, then the operator returns the input geometries. Unless the `unit` option is set, the default is the spatial reference unit of `geometries`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-generalizeOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], maxDeviation: number, options?: generalizeOperatorExecuteManyOptions): GeometryUnion[]; } export const generalizeOperator: generalizeOperator; export interface generalizeOperatorExecuteManyOptions { removeDegenerateParts?: boolean; unit?: LengthUnit; } export interface generalizeOperatorExecuteOptions { removeDegenerateParts?: boolean; unit?: LengthUnit; } /** * Geodesically buffer 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicBufferOperator.html Read more...} */ interface geodesicBufferOperator { readonly supportsCurves: boolean | nullish; /** * Creates a geodesic buffer around the input geometry. * * @param geometry The geometry to buffer. * @param distance The buffer distance for the geometry. Unless the `unit` option is set, the default is meters. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicBufferOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, distance: number, options?: geodesicBufferOperatorExecuteOptions): Polygon | nullish; /** * Creates a geodesic buffer around the input geometries. * * @param geometries The set of geometries to buffer. All the geometries must have the same spatial reference. * @param distances The buffer distance for each of the geometries. Unless the `unit` option is set, the default is meters. If the size of the distances array is less than the number of geometries in the input geometries, the last distance value is used for the rest of geometries. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicBufferOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], distances: number[], options?: geodesicBufferOperatorExecuteManyOptions): Polygon[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicBufferOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicBufferOperator.html#load Read more...} */ load(): Promise; } export const geodesicBufferOperator: geodesicBufferOperator; export interface geodesicBufferOperatorExecuteManyOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; maxDeviation?: number; union?: boolean; unit?: LengthUnit; } export interface geodesicBufferOperatorExecuteOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; maxDeviation?: number; unit?: LengthUnit; } /** * Finds closest vertices of a 2D geometry using geodesic distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html Read more...} */ interface geodesicProximityOperator { readonly supportsCurves: boolean | nullish; /** * Returns the nearest coordinate on the geometry to the given input point. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#getNearestCoordinate Read more...} */ getNearestCoordinate(geometry: GeometryUnion, point: Point, options?: geodesicProximityOperatorGetNearestCoordinateOptions): ProximityResult; /** * Returns the nearest vertex on the geometry. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in the input `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#getNearestVertex Read more...} */ getNearestVertex(geometry: GeometryUnion, point: Point, options?: geodesicProximityOperatorGetNearestVertexOptions): ProximityResult; /** * Returns vertices of the geometry that are closer to the given point than the given radius. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in `geometry`. * @param searchRadius The distance to search from the `point` to the nearest vertices in the `geometry`. Unless the `unit` option is set, the default is meters. * @param maxVertexCountToReturn The maximum number of vertices that will be returned. Must be a positive number. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#getNearestVertices Read more...} */ getNearestVertices(geometry: GeometryUnion, point: Point, searchRadius: number, maxVertexCountToReturn: number, options?: geodesicProximityOperatorGetNearestVerticesOptions): ProximityResult[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#load Read more...} */ load(): Promise; } export const geodesicProximityOperator: geodesicProximityOperator; export interface geodesicProximityOperatorGetNearestCoordinateOptions { calculateLeftRightSide?: boolean; maxDeviation?: number; testPolygonInterior?: boolean; unit?: LengthUnit; } export interface geodesicProximityOperatorGetNearestVertexOptions { unit?: LengthUnit; } export interface geodesicProximityOperatorGetNearestVerticesOptions { unit?: LengthUnit; } /** * Object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#getNearestCoordinate getNearestCoordinate()}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#nearestVegetNearestVertex getNearestVertex()}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#getNearestVertices getNearestVertices()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodesicProximityOperator.html#ProximityResult Read more...} */ export interface ProximityResult { coordinate: Point; distance: number; isEmpty: boolean; isRightSide?: boolean; vertexIndex: number; } /** * Returns the geodetic area of a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticAreaOperator.html Read more...} */ interface geodeticAreaOperator { readonly supportsCurves: boolean | nullish; /** * Calculates the geodetic area of the input Geometry. * * @param geometry The input geometry. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticAreaOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, options?: geodeticAreaOperatorExecuteOptions): number; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticAreaOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticAreaOperator.html#load Read more...} */ load(): Promise; } export const geodeticAreaOperator: geodeticAreaOperator; export interface geodeticAreaOperatorExecuteOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; unit?: AreaUnit; } /** * Densifies line segments by length in a 2D plane, making them run along specified geodetic curves. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDensifyOperator.html Read more...} */ interface geodeticDensifyOperator { readonly supportsCurves: boolean | nullish; /** * Densifies the input geometry. * * @param geometry The input geometry to be densified. * @param maxSegmentLength The maximum segment length allowed. Unless the `unit` option is set, the default is meters. Must be a positive value. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDensifyOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, maxSegmentLength: number, options?: geodeticDensifyOperatorExecuteOptions): GeometryUnion | nullish; /** * Densifies the input geometries. * * @param geometries The set of geometries to be densified. All the geometries must have the same spatial reference. * @param maxSegmentLength The maximum segment length allowed. Unless the `unit` option is set, the default is meters. Must be a positive value. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDensifyOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], maxSegmentLength: number, options?: geodeticDensifyOperatorExecuteManyOptions): (GeometryUnion | nullish)[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDensifyOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDensifyOperator.html#load Read more...} */ load(): Promise; } export const geodeticDensifyOperator: geodeticDensifyOperator; export interface geodeticDensifyOperatorExecuteManyOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; unit?: LengthUnit; } export interface geodeticDensifyOperatorExecuteOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; unit?: LengthUnit; } /** * Calculates the shortest geodetic distance between two 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDistanceOperator.html Read more...} */ interface geodeticDistanceOperator { readonly supportsCurves: boolean | nullish; /** * Calculates the shortest geodetic distance between two geometries. * * @param geometry1 The first input geometry. * @param geometry2 The second input geometry. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDistanceOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion, options?: geodeticDistanceOperatorExecuteOptions): number; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDistanceOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticDistanceOperator.html#load Read more...} */ load(): Promise; } export const geodeticDistanceOperator: geodeticDistanceOperator; export interface geodeticDistanceOperatorExecuteOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section"; unit?: LengthUnit; } /** * Returns the geodetic length of a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticLengthOperator.html Read more...} */ interface geodeticLengthOperator { readonly supportsCurves: boolean | nullish; /** * Calculates the geodetic length of the input Geometry. * * @param geometry The input geometry. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticLengthOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, options?: geodeticLengthOperatorExecuteOptions): number; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticLengthOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-geodeticLengthOperator.html#load Read more...} */ load(): Promise; } export const geodeticLengthOperator: geodeticLengthOperator; export interface geodeticLengthOperatorExecuteOptions { curveType?: "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving"; unit?: LengthUnit; } /** * Creates planar buffers around 2D geometries using graphical joins and caps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-graphicBufferOperator.html Read more...} */ interface graphicBufferOperator { readonly supportsCurves: boolean; /** * Creates a buffer around the input geometries, using graphical joins and caps. * * @param geometries The input geometries to be buffered. All the geometries must have the same spatial reference. * @param distances The buffer distances for the geometries. If the size of this array is less than the number of geometries in the input `geometries`, the last distance value is used for the rest of geometries. Unless the `unit` option is set, the default is the geometries spatial reference unit. * @param joins * Defines the buffers shape where geometries are joined. * * Miter joins are replaced with bevel when the ratio of the miter thickness to the buffer distance is greater than miter limit. The miter thickness is the distance from the vertex to the mitered corner of the buffer that this vertex generates. * @param caps * Defines the buffers shape at the end points of the geometries. * * Points with square caps will be drawn as squares. * * Open polylines paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance). * * Open polylines paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance). * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-graphicBufferOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], distances: number[], joins: "round" | "miter" | "bevel", caps: "round" | "butt" | "square", options?: graphicBufferOperatorExecuteManyOptions): Polygon[]; } export const graphicBufferOperator: graphicBufferOperator; export interface graphicBufferOperatorExecuteManyOptions { maxDeviation?: number; maxVerticesInFullCircle?: number; miterLimit?: number; union?: boolean; unit?: LengthUnit; } /** * Performs an Integration operation on a set of 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-integrateOperator.html Read more...} */ interface integrateOperator { readonly supportsCurves: boolean; /** * Performs the topological integration of the geometry set in the XY plane. * * @param geometries The set of geometries to integrate. All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-integrateOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): GeometryUnion[]; } export const integrateOperator: integrateOperator; /** * Create new geometries using the topological intersection of 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectionOperator.html Read more...} */ interface intersectionOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectionOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Performs the topological intersection operation on two geometries. * * @param geometry1 The geometry to intersect with `geometry2`. * @param geometry2 The geometry to intersect with `geometry1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectionOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): GeometryUnion | nullish; /** * Performs the topological intersection operation on the geometry set. * * @param geometries The set of input geometries to be intersected by the `intersector`. All the geometries must have the same spatial reference. * @param intersector The geometry to intersect with the `geometries`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectionOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], intersector: GeometryUnion): GeometryUnion[]; } export const intersectionOperator: intersectionOperator; /** * Performs a relational operation to determine if one 2D geometry intersects another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectsOperator.html Read more...} */ interface intersectsOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectsOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform a intersects operation on two geometries. * * @param geometry1 The geometry that is tested for the intersects relationship to `geometry2`. * @param geometry2 The geometry being intersected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-intersectsOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const intersectsOperator: intersectsOperator; /** * Performs a 2D relational operation that checks if two geometries are near each other. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-isNearOperator.html Read more...} */ interface isNearOperator { readonly supportsCurves: boolean; /** * Returns true if the geometries are not further than the given 2D distance from each other. * * @param geometry1 The first geometry. * @param geometry2 The second geometry. * @param distance The distance (must be positive). Unless the `unit` option is set, the default is the geometry's spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-isNearOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion, distance: number, options?: isNearOperatorExecuteOptions): boolean; } export const isNearOperator: isNearOperator; export interface isNearOperatorExecuteOptions { unit?: LengthUnit; } /** * Calculates a label point for the given 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-labelPointOperator.html Read more...} */ interface labelPointOperator { readonly supportsCurves: boolean; /** * Performs the label point operation on the geometry. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-labelPointOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): Point; /** * Performs the label point operation on the geometry set. * * @param geometries The set of input geometries. All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-labelPointOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): Point[]; } export const labelPointOperator: labelPointOperator; /** * Returns the planar length of a 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-lengthOperator.html Read more...} */ interface lengthOperator { readonly supportsCurves: boolean; /** * Calculates the planar length of the input geometry. * * @param geometry The geometry to calculate the length from. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-lengthOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, options?: lengthOperatorExecuteOptions): number; } export const lengthOperator: lengthOperator; export interface lengthOperatorExecuteOptions { unit?: LengthUnit; } /** * Performs the topological operation of breaking the input set of 2D polygons and polylines into segments and rebuilding a new set of polygons from the non-intersecting areas. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-linesToPolygonsOperator.html Read more...} */ interface linesToPolygonsOperator { readonly supportsCurves: boolean; /** * Performs the topological lines to polygons operation. * * @param geometries The set of input geometries. All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-linesToPolygonsOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): Polygon[]; } export const linesToPolygonsOperator: linesToPolygonsOperator; /** * Performs an OGC locate between operation on M values for the given 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-locateBetweenOperator.html Read more...} */ interface locateBetweenOperator { readonly supportsCurves: boolean; /** * Performs the locate between or locate along operation on the geometry. * * @param geometries The set of input geometries. All the geometries must have the same spatial reference. * @param startM The M value to start the operation. * @param endM The M value to end the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-locateBetweenOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], startM: number, endM: number): (GeometryUnion | nullish)[]; } export const locateBetweenOperator: locateBetweenOperator; /** * Create a minimum bounding circle for the input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-minimumBoundingCircleOperator.html Read more...} */ interface minimumBoundingCircleOperator { readonly supportsCurves: boolean; /** * Performs the minimum bounding circle operation on the geometry. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-minimumBoundingCircleOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): Polygon; /** * Performs the minimum bounding circle operation on the geometry set. * * @param geometries The set of input geometries. All the geometries must have the same spatial reference. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-minimumBoundingCircleOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], options?: minimumBoundingCircleOperatorExecuteManyOptions): Polygon[]; } export const minimumBoundingCircleOperator: minimumBoundingCircleOperator; export interface minimumBoundingCircleOperatorExecuteManyOptions { merge?: boolean; } /** * Convert multipart 2D geometries to single part geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-multiPartToSinglePartOperator.html Read more...} */ interface multiPartToSinglePartOperator { readonly supportsCurves: boolean; /** * Performs the multipart to single part operation on the input geometries. * * @param geometries The input geometries to be converted to single part geometries. All the geometries must have the same spatial reference. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-multiPartToSinglePartOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], options?: multiPartToSinglePartOperatorExecuteManyOptions): GeometryUnion[]; } export const multiPartToSinglePartOperator: multiPartToSinglePartOperator; export interface multiPartToSinglePartOperatorExecuteManyOptions { simplifyPolygons?: boolean; } /** * Offset 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-offsetOperator.html Read more...} */ interface offsetOperator { readonly supportsCurves: boolean; /** * Creates an offset version of the input geometry. * * @param geometry The input geometry. Can be an extent, polyline, or polygon. Point and multipoint geometries are not supported. * @param distance The distance to offset the input geometry. Unless the `unit` option is set, the default is the geometry's spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-offsetOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, distance: number, options?: offsetOperatorExecuteOptions): GeometryUnion; /** * Creates offset versions of the input geometries. * * @param geometries The set of input geometries. Can be extents, polylines, or polygons. Point and multipoint geometries are not supported. All the geometries must have the same spatial reference. * @param distance The distance to offset the input geometries. Unless the `unit` option is set, the default is the geometries spatial reference unit. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-offsetOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], distance: number, options?: offsetOperatorExecuteManyOptions): GeometryUnion[]; } export const offsetOperator: offsetOperator; export interface offsetOperatorExecuteManyOptions { flattenError?: number; joins?: "round" | "miter" | "bevel" | "square"; miterLimit?: number; unit?: LengthUnit; } export interface offsetOperatorExecuteOptions { flattenError?: number; joins?: "round" | "miter" | "bevel" | "square"; miterLimit?: number; unit?: LengthUnit; } /** * Performs a relational operation to determine if two 2D geometries of the same dimension overlap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-overlapsOperator.html Read more...} */ interface overlapsOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-overlapsOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform the overlaps operation on two geometries. * * @param geometry1 The base geometry that is tested for the "overlaps" relationship with `geometry2`. * @param geometry2 The comparison geometry that is tested for the "overlaps" relationship with `geometry1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-overlapsOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const overlapsOperator: overlapsOperator; /** * Performs an overlay operation on a set of 2D polygons in the XY plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonOverlayOperator.html Read more...} */ interface polygonOverlayOperator { readonly supportsCurves: boolean; /** * Performs the topological overlay of the geometry set in the XY plane. * * @param polygons The set of polygons to overlay. All the polygons must have the same spatial reference. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonOverlayOperator.html#executeMany Read more...} */ executeMany(polygons: Polygon[], options?: polygonOverlayOperatorExecuteManyOptions): ExecuteManyResult; } export const polygonOverlayOperator: polygonOverlayOperator; /** * Object returned by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonOverlayOperator.html#executeMany executeMany()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonOverlayOperator.html#ExecuteManyResult Read more...} */ export interface ExecuteManyResult { results: Polygon[]; ids: number[][]; } export interface polygonOverlayOperatorExecuteManyOptions { gaps?: boolean; holes?: boolean; noOverlaps?: boolean; overlaps?: boolean; multiPart?: boolean; } /** * Performs a topological operation for slicing a 2D polygon into smaller polygons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonSlicerOperator.html Read more...} */ interface polygonSlicerOperator { readonly supportsCurves: boolean; /** * Finds positions of the sliced strips for a given polygon given the number of equal area parts to slice the polygon into. * * @param polygon The input polygon. * @param partCount The number of parts to slice into. * @param remainingArea The size of the remaining piece of the uncut polygon. Pass zero, if you want to slice the whole polygon. Unless the `unit` option is set, the default is the spatial reference unit of `polygon`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonSlicerOperator.html#findSlicesByArea Read more...} */ findSlicesByArea(polygon: Polygon, partCount: number, remainingArea: number, options?: polygonSlicerOperatorFindSlicesByAreaOptions): number[]; /** * Slices the given polygon into equal area parts, not necessarily strips. * * @param polygon The input polygon to slice. * @param partCount The number of equal area parts to slice the polygon into. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonSlicerOperator.html#recursiveSliceEqualArea Read more...} */ recursiveSliceEqualArea(polygon: Polygon, partCount: number, options?: polygonSlicerOperatorRecursiveSliceEqualAreaOptions): Polygon[]; /** * Slices the given polygon into strips. * * @param polygon The input polygon to slice. * @param ySlices The array of y coordinates, sorted in ascending order. The polygon will be transformed with the transform, and then it will be sliced horizontally at each y coordinate. That is, the `ySlices` are given in the coordinates after transform is applied to the polygon. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-polygonSlicerOperator.html#sliceIntoStrips Read more...} */ sliceIntoStrips(polygon: Polygon, ySlices: number[], options?: polygonSlicerOperatorSliceIntoStripsOptions): Polygon[]; } export const polygonSlicerOperator: polygonSlicerOperator; export interface polygonSlicerOperatorFindSlicesByAreaOptions { transform?: Transformation; unit?: AreaUnit; } export interface polygonSlicerOperatorRecursiveSliceEqualAreaOptions { transform?: Transformation; } export interface polygonSlicerOperatorSliceIntoStripsOptions { transform?: Transformation; } /** * Projects 2D geometries from one {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} to another. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-projectOperator.html Read more...} */ interface projectOperator { readonly supportsCurves: boolean | nullish; /** * Projects a geometry to the specified output spatial reference. * * @param geometry The geometry to project. * @param outSpatialReference The spatial reference to which the input geometry is projected. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-projectOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: projectOperatorExecuteOptions): GeometryUnion | nullish; /** * Projects an array of geometries to the specified output spatial reference. * * @param geometries An array of geometries to project. All the geometries must have the same spatial reference. * @param outSpatialReference The spatial reference to which the input geometry is projected. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-projectOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: projectOperatorExecuteManyOptions): (GeometryUnion | nullish)[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-projectOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-projectOperator.html#load Read more...} */ load(): Promise; } export const projectOperator: projectOperator; export interface projectOperatorExecuteManyOptions { areaOfInterestExtent?: Extent; geographicTransformation?: GeographicTransformation; } export interface projectOperatorExecuteOptions { areaOfInterestExtent?: Extent; geographicTransformation?: GeographicTransformation; } /** * Find the closest vertices of the 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html Read more...} */ interface proximityOperator { readonly supportsCurves: boolean; /** * Returns the nearest coordinate on the geometry to the given input point. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#getNearestCoordinate Read more...} */ getNearestCoordinate(geometry: GeometryUnion, point: Point, options?: proximityOperatorGetNearestCoordinateOptions): proximityOperatorProximityResult; /** * Returns the nearest vertex on the geometry. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in the input `geometry`. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#getNearestVertex Read more...} */ getNearestVertex(geometry: GeometryUnion, point: Point, options?: proximityOperatorGetNearestVertexOptions): proximityOperatorProximityResult; /** * Returns vertices of the geometry that are closer to the given point than the given radius. * * @param geometry The input geometry. * @param point The point used to search for the nearest coordinate in `geometry`. * @param searchRadius The planar distance from the `inputPoint` to search for vertices. Unless the `unit` option is set, the default is the geometry's spatial reference unit. * @param maxVertexCountToReturn The maximum number of vertices that will be returned. Must be a positive number. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#getNearestVertices Read more...} */ getNearestVertices(geometry: GeometryUnion, point: Point, searchRadius: number, maxVertexCountToReturn: number, options?: proximityOperatorGetNearestVerticesOptions): proximityOperatorProximityResult[]; } export const proximityOperator: proximityOperator; export interface proximityOperatorGetNearestCoordinateOptions { calculateLeftRightSide?: boolean; testPolygonInterior?: boolean; unit?: LengthUnit; } export interface proximityOperatorGetNearestVertexOptions { unit?: LengthUnit; } export interface proximityOperatorGetNearestVerticesOptions { unit?: LengthUnit; } /** * Object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#getNearestCoordinate getNearestCoordinate()}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#nearestVegetNearestVertex getNearestVertex()}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#getNearestVertices getNearestVertices()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-proximityOperator.html#ProximityResult Read more...} */ export interface proximityOperatorProximityResult { coordinate: Point; distance: number; isEmpty: boolean; isRightSide?: boolean; vertexIndex: number; } /** * Performs a relational operation between two 2D geometries using the DE-9IM matrix encoded as a string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-relateOperator.html Read more...} */ interface relateOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-relateOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; execute(geometry1: GeometryUnion, geometry2: GeometryUnion, relation: string): boolean; /** * Indicates if the DE-9IM matrix relation is valid. * * @param relation The DE-9IM matrix relation encoded as a string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-relateOperator.html#isValidDE9IM Read more...} */ isValidDE9IM(relation: string): boolean; } export const relateOperator: relateOperator; /** * Reshape 2D polygons or polylines with a single path polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-reshapeOperator.html Read more...} */ interface reshapeOperator { readonly supportsCurves: boolean; /** * Performs the reshape operation on a polygon or polyline using a single path polyline as the reshaper. * * @param geometry The polygon or polyline to be reshaped. * @param reshaper The single path polyline reshaper. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-reshapeOperator.html#execute Read more...} */ execute(geometry: Polygon | Polyline, reshaper: Polyline): Polygon | Polyline | nullish; } export const reshapeOperator: reshapeOperator; /** * Transforms 2D geometry segment end points and interior points, thus preserving the geographic location of the segment interior and more accurately maintaining its original shape. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-shapePreservingProjectOperator.html Read more...} */ interface shapePreservingProjectOperator { readonly supportsCurves: boolean | nullish; /** * Performs the shape preserving project operation on a single geometry. * * @param geometry The geometry to be projected. * @param outSpatialReference The spatial reference to which the input geometry is projected. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-shapePreservingProjectOperator.html#execute Read more...} */ execute(geometry: GeometryUnion, outSpatialReference: SpatialReference, options?: shapePreservingProjectOperatorExecuteOptions): GeometryUnion | nullish; /** * Performs the shape preserving project operation on multiple geometries. * * @param geometries The geometries to be projected. All the geometries must have the same spatial reference. * @param outSpatialReference The spatial reference to which the input geometries are projected. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-shapePreservingProjectOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: shapePreservingProjectOperatorExecuteManyOptions): (GeometryUnion | nullish)[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-shapePreservingProjectOperator.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-shapePreservingProjectOperator.html#load Read more...} */ load(): Promise; } export const shapePreservingProjectOperator: shapePreservingProjectOperator; export interface shapePreservingProjectOperatorExecuteManyOptions { areaOfInterestExtent?: Extent; geographicTransformation?: GeographicTransformation; minSegmentLengthInDegrees?: number; maxDeviationInSrTo?: number; } export interface shapePreservingProjectOperatorExecuteOptions { areaOfInterestExtent?: Extent; geographicTransformation?: GeographicTransformation; minSegmentLengthInDegrees?: number; maxDeviationInSrTo?: number; } /** * Simplifies geometries to enforce topological correctness according to the [OGC Simple Feature Access specification 1.2.1](https://www.ogc.org/standards/sfa/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOGCOperator.html Read more...} */ interface simplifyOGCOperator { readonly supportsCurves: boolean; /** * Performs the OGC simplify operation on a single geometry. * * @param geometry The geometry to be simplified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOGCOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): GeometryUnion | nullish; /** * Performs the OGC simplify operation on the geometry set. * * @param geometries The array of geometries to be simplified, All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOGCOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): (GeometryUnion | nullish)[]; /** * Indicates if the given geometry is OGC topologically simple. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOGCOperator.html#isSimple Read more...} */ isSimple(geometry: GeometryUnion): boolean; } export const simplifyOGCOperator: simplifyOGCOperator; /** * Applies GeoScene (non-OGC) simplification to 2D geometries by removing unnecessary vertices while preserving the geometry shape. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html Read more...} */ interface simplifyOperator { readonly supportsCurves: boolean; /** * Performs the simplify operation on a single geometry. * * @param geometry The geometry to be simplified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html#execute Read more...} */ execute(geometry: GeometryUnion): GeometryUnion | nullish; /** * Performs the simplify operation on the geometry set. * * @param geometries The array of geometries to be simplified, All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): (GeometryUnion | nullish)[]; /** * Indicates if the given geometry is non-OGC topologically simple. * * @param geometry The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html#isSimple Read more...} */ isSimple(geometry: GeometryUnion): boolean; } export const simplifyOperator: simplifyOperator; export class GeographicTransformation extends Accessor { /** * Create a geographic transformation that can be used to project 2D geometries between different geographic coordinate systems to ensure that data is properly aligned within a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformation.html Read more...} */ constructor(properties?: GeographicTransformationProperties); /** * An ordered list of geographic transformation steps that represent the process of transforming coordinates from one geographic coordinate system to another. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformation.html#steps Read more...} */ get steps(): GeographicTransformationStep[]; set steps(value: GeographicTransformationStepProperties[]); /** * Returns the inverse of this geographic transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformation.html#getInverse Read more...} */ getInverse(): GeographicTransformation; } interface GeographicTransformationProperties { /** * An ordered list of geographic transformation steps that represent the process of transforming coordinates from one geographic coordinate system to another. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformation.html#steps Read more...} */ steps?: GeographicTransformationStepProperties[]; } export class GeographicTransformationStep extends Accessor { /** * Indicates if the geographic transformation is inverted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#isInverse Read more...} */ isInverse: boolean; /** * The well-known id (wkid) hat represents a known geographic transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#wkid Read more...} */ wkid: number | nullish; /** * The well-known text (wkt) that represents a known geographic transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#wkt Read more...} */ wkt: string | nullish; /** * Represents a step in the process of transforming coordinates from one geographic coordinate system to another. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html Read more...} */ constructor(properties?: GeographicTransformationStepProperties); /** * Returns the inverse of this geographic transformation step. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#getInverse Read more...} */ getInverse(): GeographicTransformationStep; } interface GeographicTransformationStepProperties { /** * Indicates if the geographic transformation is inverted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#isInverse Read more...} */ isInverse?: boolean; /** * The well-known id (wkid) hat represents a known geographic transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#wkid Read more...} */ wkid?: number | nullish; /** * The well-known text (wkt) that represents a known geographic transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-GeographicTransformationStep.html#wkt Read more...} */ wkt?: string | nullish; } /** * A set of utilities for working with geographic transformations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-geographicTransformationUtils.html Read more...} */ interface geographicTransformationUtils { /** * Returns the default equation-based, geographic transformation used to convert a geometry * from the input spatial reference to the output spatial reference. * * @param inSpatialReference The input spatial reference from which to project geometries. This is the spatial reference of the input geometries. * @param outSpatialReference The spatial reference to which you are converting the geometries. * @param areaOfInterestExtent An extent used to determine the suitability of the returned transformation. The extent's spatial reference should be the same as `inSpatialReference`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-geographicTransformationUtils.html#getTransformation Read more...} */ getTransformation(inSpatialReference: SpatialReference, outSpatialReference: SpatialReference, areaOfInterestExtent?: Extent | nullish): GeographicTransformation | nullish; /** * Returns a list of all equation-based, geographic transformations suitable to convert geometries from the input spatial reference * to the specified output spatial reference. * * @param inSpatialReference The spatial reference that the geometries are currently using. * @param outSpatialReference The spatial reference to which you are converting the geometries to. * @param areaOfInterestExtent An extent used to help pick the correct transform. The extent's spatial reference should be the same as `inSpatialReference`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-geographicTransformationUtils.html#getTransformations Read more...} */ getTransformations(inSpatialReference: SpatialReference, outSpatialReference: SpatialReference, areaOfInterestExtent?: Extent | nullish): GeographicTransformation[]; /** * Indicates if all dependencies of this module have been loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-geographicTransformationUtils.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-geographicTransformationUtils.html#load Read more...} */ load(): Promise; } export const geographicTransformationUtils: geographicTransformationUtils; export class Transformation { constructor(); /** * Calculates distance errors for a transformation on a given set of the input points to the output points. * * @param input The input points to transform from. * @param output The output points to transform to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#calculateErrors Read more...} */ calculateErrors(input: Point[], output: Point[]): ErrorResult; /** * Flips all the `x` coordinates of geometries on the vertical y-axis (right or left) that is centered between `x0` and `x1`. * * @param x0 The x-coordinate of the first geometry. * @param x1 The x-coordinate of the second geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#flipX Read more...} */ flipX(x0: number, x1: number): void; /** * Flips all the `y` coordinates of geometries on the horizontal x-axis (up or down) that is centered between `y0` and `y1`. * * @param y0 The y-coordinate of the first geometry. * @param y1 The y-coordinate of the second geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#flipY Read more...} */ flipY(y0: number, y1: number): void; /** * Initializes a new transformation from the input and output control points. * * @param type * The type of transformation to initialize. * * Value | Description * ------|------------ * "conformal" | Preserves the angles between curves. * "general" | Preserves lines and parallelisms. Does not preserve angles or lengths. * @param input The input points to transform from. * @param output The output points to transform to. * @param inverseOut The transformation instance that is the inverse of the calculated transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#initializeFromControlPoints Read more...} */ initializeFromControlPoints(type: "conformal" | "general", input: Point[], output: Point[], inverseOut?: any): void; /** * Determines if the transformation is in its default state, which is an identity matrix. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#isIdentity Read more...} */ isIdentity(): boolean; /** * Rotates the geometries by the specified angle in degrees around the point specified by the x and y coordinates. * * @param angleInDegrees The angle to rotate the geometries in degrees. * @param rotationX The x-coordinate of the point to rotate around. * @param rotationY The y-coordinate of the point to rotate around. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#rotate Read more...} */ rotate(angleInDegrees: number, rotationX: number, rotationY: number): void; /** * Resizes the geometries by the specified scale factors defined by the x and y coordinates. * * @param x The x-coordinate that defines the horizontal scale factor. * @param y The y-coordinate that defines the vertical scale factor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#scale Read more...} */ scale(x: number, y: number): void; /** * Use this method to reset the transformation to its default state, which is an identity matrix. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#setIdentity Read more...} */ setIdentity(): void; /** * Use this method to swap the x and y coordinate values in the transformation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#setSwapCoordinates Read more...} */ setSwapCoordinates(): void; /** * Shifts a geometry's points by the specified proportion in parallel to the x and y directions, * except those points that are along the shear axis, which is a line defined by the x and y coordinates. * * @param proportionX The proportion to shear the geometry in the x direction. * @param proportionY The proportion to shear the geometry in the y direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#shear Read more...} */ shear(proportionX: number, proportionY: number): void; /** * Shifts all the coordinates of the geometries by the distance and direction between the specified `x` and `y` coordinates and their current location. * * @param x The x-coordinate to shift by. * @param y The y-coordinate to shift by. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#shift Read more...} */ shift(x: number, y: number): void; } /** * Object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#calculateErrors calculateErrors()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-support-Transformation.html#ErrorResult Read more...} */ export interface ErrorResult { rms: number; errorsOut: number[]; } /** * Returns the symmetric difference between 2D geometries, also known as exclusive OR, or XOR. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-symmetricDifferenceOperator.html Read more...} */ interface symmetricDifferenceOperator { readonly supportsCurves: boolean; /** * Performs the symmetric difference (XOR) operation on two geometries. * * @param leftGeometry The first geometry to be XOR'd. * @param rightGeometry The second geometry to be XOR'd. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-symmetricDifferenceOperator.html#execute Read more...} */ execute(leftGeometry: GeometryUnion, rightGeometry: GeometryUnion): GeometryUnion; /** * Performs the symmetric difference (XOR) operation on every geometry in `inputGeometries` with `rightGeometry`. * * @param inputGeometries The set of geometries to be XOR'd by the `rightGeometry`. * @param rightGeometry The geometry being XOR'd with the `inputGeometries`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-symmetricDifferenceOperator.html#executeMany Read more...} */ executeMany(inputGeometries: GeometryUnion[], rightGeometry: GeometryUnion): GeometryUnion[]; } export const symmetricDifferenceOperator: symmetricDifferenceOperator; /** * Perform a relational operation to determine if one 2D geometry touches another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-touchesOperator.html Read more...} */ interface touchesOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-touchesOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform a touches operation on two geometries. * * @param geometry1 The base geometry that is tested for the "touches" relationship with `geometry2`. * @param geometry2 The comparison geometry that is tested for the "touches" relationship with `geometry1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-touchesOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean; } export const touchesOperator: touchesOperator; /** * Perform a topological union (dissolve) operation on 2D geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-unionOperator.html Read more...} */ interface unionOperator { readonly supportsCurves: boolean; /** * Perform a topological union operation on two geometries. * * @param geometry1 The first geometry to union with. * @param geometry2 The second geometry to union with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-unionOperator.html#execute Read more...} */ execute(geometry1: GeometryUnion, geometry2: GeometryUnion): GeometryUnion | nullish; /** * Perform a topological union operation on a geometry set. * * @param geometries The array of geometries to union. All the geometries must have the same spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-unionOperator.html#executeMany Read more...} */ executeMany(geometries: GeometryUnion[]): GeometryUnion | nullish; } export const unionOperator: unionOperator; /** * Perform a relational operation to determine if one 2D geometry is within another 2D geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-withinOperator.html Read more...} */ interface withinOperator { readonly supportsCurves: boolean; /** * Accelerate a geometry. * * @param geometry The geometry to accelerate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-withinOperator.html#accelerateGeometry Read more...} */ accelerateGeometry(geometry: GeometryUnion): boolean; /** * Perform a within operation on two geometries. * * @param inner The base geometry that is tested for the "within" relationship with `outer`. * @param outer The comparison geometry that is tested for the "contains" relationship with `inner`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-withinOperator.html#execute Read more...} */ execute(inner: GeometryUnion, outer: GeometryUnion): boolean; } export const withinOperator: withinOperator; export class Point extends Geometry { /** * The latitude of the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#latitude Read more...} */ latitude: number | nullish; /** * The longitude of the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#longitude Read more...} */ longitude: number | nullish; /** * The m-coordinate of the point in map units. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#m Read more...} */ m: number | undefined; /** * The string value representing the type of geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#type Read more...} */ readonly type: "point"; /** * The x-coordinate (easting) of the point in map units. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#x Read more...} */ x: number; /** * The y-coordinate (northing) of the point in map units. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#y Read more...} */ y: number; /** * The z-coordinate (or elevation) of the point in map units. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#z Read more...} */ z: number | undefined; /** * A location defined by X, Y, and Z coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Read more...} */ constructor(properties?: PointProperties); /** * Creates a deep clone of Point object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#clone Read more...} */ clone(): Point; /** * Copies all values from another Point instance. * * @param other The point to copy from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#copy Read more...} */ copy(other: Point): this; /** * Computes the Euclidean distance between this Point and a given Point. * * @param other The point to compute the distance to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#distance Read more...} */ distance(other: Point): number; /** * Determines if the input point is equal to the point calling the function. * * @param point The input point to test. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#equals Read more...} */ equals(point: Point | nullish): boolean; /** * Modifies the point geometry in-place by shifting the X-coordinate to within * +/- 180 span in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#normalize Read more...} */ normalize(): Point; static fromJSON(json: any): Point; } interface PointProperties extends GeometryProperties { /** * The latitude of the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#latitude Read more...} */ latitude?: number | nullish; /** * The longitude of the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#longitude Read more...} */ longitude?: number | nullish; /** * The m-coordinate of the point in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#m Read more...} */ m?: number | undefined; /** * The x-coordinate (easting) of the point in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#x Read more...} */ x?: number; /** * The y-coordinate (northing) of the point in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#y Read more...} */ y?: number; /** * The z-coordinate (or elevation) of the point in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html#z Read more...} */ z?: number | undefined; } export class Polygon extends Geometry { /** * The centroid of the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#centroid Read more...} */ readonly centroid: Point | nullish; /** * 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. * * @deprecated since 4.33. Please use {@link module:geoscene/geometry/operators/simplifyOperator#isSimple simplifyOperator.isSimple()} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#isSelfIntersecting Read more...} */ readonly isSelfIntersecting: boolean; /** * An array of rings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#rings Read more...} */ rings: number[][][]; /** * The string value representing the type of geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#type Read more...} */ readonly type: "polygon"; /** * A polygon contains an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#rings rings} and a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#spatialReference spatialReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Read more...} */ constructor(properties?: PolygonProperties); /** * Adds a ring to the Polygon. * * @param points A polygon ring. The first and last coordinates/points in the ring must be the same. This can either be defined as an array of Point geometries or an array of XY coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#addRing Read more...} */ addRing(points: Point[] | number[][]): Polygon; /** * Creates a deep clone of Polygon object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#clone Read more...} */ clone(): Polygon; /** * Checks on the client if the input point is inside the polygon. * * @param point The point to test whether it is contained within the testing polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#contains Read more...} */ contains(point: Point): boolean; /** * Returns a point specified by a ring and point in the path. * * @param ringIndex The index of the ring containing the desired point. * @param pointIndex The index of the desired point within the ring. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#getPoint Read more...} */ getPoint(ringIndex: number, pointIndex: number): Point | nullish; /** * Inserts a new point into the polygon. * * @param ringIndex The index of the ring in which to insert the point. * @param pointIndex The index of the point to insert within the ring. * @param point The point to insert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#insertPoint Read more...} */ insertPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; /** * Checks if a Polygon ring is clockwise. * * @param ring A polygon ring. It can either be defined as an array of Point geometries or an array of XY coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#isClockwise Read more...} */ isClockwise(ring: Point[] | number[][]): boolean; /** * Removes a point from the polygon at the given `pointIndex` within the ring identified by `ringIndex`. * * @param ringIndex The index of the ring containing the point to remove. * @param pointIndex The index of the point to remove within the ring. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#removePoint Read more...} */ removePoint(ringIndex: number, pointIndex: number): Point | nullish; /** * Removes a ring from the Polygon. * * @param index The index of the ring to remove. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#removeRing Read more...} */ removeRing(index: number): Point[] | nullish; /** * Updates a point in the polygon. * * @param ringIndex The index of the ring containing the point to update. * @param pointIndex The index of the point to update within the ring. * @param point The new point geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#setPoint Read more...} */ setPoint(ringIndex: number, pointIndex: number, point: Point | number[]): Polygon; /** * Converts the given Extent to a Polygon instance. * * @param extent An extent object to convert to a polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#fromExtent Read more...} */ static fromExtent(extent: Extent): Polygon; static fromJSON(json: any): Polygon; } interface PolygonProperties extends GeometryProperties { /** * An array of rings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html#rings Read more...} */ rings?: number[][][]; } export class Polyline extends Geometry { /** * An array of paths, or line segments, that make up the polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#paths Read more...} */ paths: number[][][]; readonly type: "polyline"; /** * A polyline contains an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#paths paths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#spatialReference spatialReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Read more...} */ constructor(properties?: PolylineProperties); /** * Adds a path, or line segment, to the polyline. * * @param points A polyline path. This can either be defined as an array of Point geometries or an array of XY coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#addPath Read more...} */ addPath(points: Point[] | number[][]): Polyline; /** * Creates a deep clone of Polyline object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#clone Read more...} */ clone(): Polyline; /** * Returns a point specified by a path and point in the path. * * @param pathIndex The index of a path in the polyline. * @param pointIndex The index of a point in a path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#getPoint Read more...} */ getPoint(pathIndex: number, pointIndex: number): Point | nullish; /** * Inserts a new point into a polyline. * * @param pathIndex The index of the path in which to insert a point. * @param pointIndex The index of the inserted point in the path. * @param point The point to insert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#insertPoint Read more...} */ insertPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline; /** * Removes a path from the Polyline. * * @param index The index of the path to remove from the polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#removePath Read more...} */ removePath(index: number): Point[] | nullish; /** * Removes a point from the polyline at the given `pointIndex` within the path identified by the given `pathIndex`. * * @param pathIndex The index of the path containing the point to be removed. * @param pointIndex The index of the point to be removed within the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#removePoint Read more...} */ removePoint(pathIndex: number, pointIndex: number): Point | nullish; /** * Updates a point in a polyline. * * @param pathIndex The index of the path that contains the point to be updated. * @param pointIndex The index of the point to be updated in the path. * @param point Point geometry to update in the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#setPoint Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html#paths Read more...} */ paths?: number[][][]; } /** * A client-side projection engine for converting geometries from one {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} * to another. * * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/projectOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html Read more...} */ interface projection { /** * Returns the default geographic transformation used to convert the geometry * from the input spatial reference to the output spatial reference. * * @param inSpatialReference The input spatial reference from which to project geometries. This is the spatial reference of the input geometries. * @param outSpatialReference The spatial reference to which you are converting the geometries. * @param extent An extent used to determine the suitability of the returned transformation. The extent will be re-projected to the `inSpatialReference` if it has a different spatial reference. * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/support/geographicTransformationUtils#getTransformation geographicTransformationUtils.getTransformation()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html#getTransformation Read more...} */ getTransformation(inSpatialReference: SpatialReferenceProperties | nullish, outSpatialReference: SpatialReferenceProperties | nullish, extent?: Extent | null): supportGeographicTransformation | nullish; /** * Returns a list of all geographic transformations suitable to convert geometries from the input spatial reference * to the specified output spatial reference. * * @param inSpatialReference The spatial reference that the geometries are currently using. * @param outSpatialReference The spatial reference to which you are converting the geometries to. * @param extent An extent used to determine the suitability of the returned transformations. The extent will be re-projected to the input spatial reference if necessary. * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/support/geographicTransformationUtils#getTransformations geographicTransformationUtils.getTransformations()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html#getTransformations Read more...} */ getTransformations(inSpatialReference: SpatialReferenceProperties, outSpatialReference: SpatialReferenceProperties, extent?: Extent | null): supportGeographicTransformation[]; /** * Indicates if all dependencies of this module have been loaded. * * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/projectOperator#isLoaded projectOperator.isLoaded()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html#isLoaded Read more...} */ isLoaded(): boolean; /** * Loads this module's dependencies. * * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/projectOperator#load projectOperator.load()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html#load Read more...} */ load(): Promise; /** * Projects a geometry or an array of geometries to the specified output spatial reference. * * @param geometry The geometry or geometries to project. * @param outSpatialReference The spatial reference to which you are converting the geometries' coordinates. * @param geographicTransformation The geographic transformation used to transform the geometries. Specify this parameter to project a geometry when the default transformation is not appropriate for your requirements. * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/projectOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html#project Read more...} */ project(geometry: GeometryUnion | GeometryUnion[], outSpatialReference: SpatialReferenceProperties | nullish, geographicTransformation?: supportGeographicTransformation | null): GeometryUnion | GeometryUnion[]; } export const projection: projection; export interface SpatialReference extends Accessor, JSONSupport { } export class SpatialReference { /** * An [image coordinate system](https://doc.geoscene.cn/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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#imageCoordinateSystem Read more...} */ imageCoordinateSystem: any | nullish; /** * Indicates if the spatial reference refers to a geographic coordinate system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#isGeographic Read more...} */ readonly isGeographic: boolean; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkid wkid} of the spatial reference object is one of the following values: * `102113`, `102100`, `3857`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#isWebMercator Read more...} */ readonly isWebMercator: boolean; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkid wkid} of the spatial reference object is * `4326`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#isWGS84 Read more...} */ readonly isWGS84: boolean; /** * Indicates if the spatial reference of the map supports wrapping around the International * Date Line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#isWrappable Read more...} */ readonly isWrappable: boolean; /** * The factor to convert one unit value in the spatial reference's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#unit unit} to meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#metersPerUnit Read more...} */ readonly metersPerUnit: number; /** * The unit of the spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#unit Read more...} */ readonly unit: | "150-kilometers" | "1865-feet" | "50-kilometers" | "benoit-1895-a-chains" | "benoit-1895-a-feet" | "benoit-1895-a-links" | "benoit-1895-a-yards" | "benoit-1895-b-chains" | "benoit-1895-b-feet" | "benoit-1895-b-links" | "benoit-1895-b-yards" | "british-1936-feet" | "centimeters" | "chains" | "clarke-chains" | "clarke-feet" | "clarke-links" | "clarke-yards" | "decimeters" | "fathoms" | "feet" | "german-meters" | "gold-coast-feet" | "inches" | "indian-1937-feet" | "indian-1937-yards" | "indian-1962-feet" | "indian-1962-yards" | "indian-1975-feet" | "indian-1975-yards" | "indian-feet" | "indian-yards" | "kilometers" | "links" | "meters" | "micrometers" | "millimeters" | "nanometers" | "nautical-miles" | "points" | "rods" | "sears-1922-truncated-chains" | "sears-1922-truncated-feet" | "sears-1922-truncated-links" | "sears-1922-truncated-yards" | "sears-chains" | "sears-feet" | "sears-links" | "sears-yards" | "smoots" | "statute-miles" | "tx-vara" | "uk-nautical-miles" | "us-chains" | "us-feet" | "us-inches" | "us-links" | "us-miles" | "us-nautical-miles" | "us-rods" | "us-yards" | "yards" | "degrees" | nullish; /** * The well-known ID of a spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkid Read more...} */ wkid: number | nullish; /** * The well-known text that defines a spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkt Read more...} */ wkt: string | nullish; /** * The well-known text of the coordinate system as defined by OGC standard for well-known text strings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkt2 Read more...} */ wkt2: string | nullish; /** * A convenience spatial reference instance for Web Mercator. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#WebMercator Read more...} */ static readonly WebMercator: SpatialReference; /** * A convenience spatial reference instance for WGS84. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#WGS84 Read more...} */ static readonly WGS84: SpatialReference; /** * Defines the spatial reference of a view, layer, or method parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html Read more...} */ constructor(properties?: SpatialReferenceProperties); /** * Returns a deep clone of the spatial reference object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#clone Read more...} */ clone(): SpatialReference; /** * Checks if the specified spatial reference object has the same {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkid wkid} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkt wkt} as this spatial reference object. * * @param spatialReference The spatial reference to compare to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#equals Read more...} */ equals(spatialReference: SpatialReference): boolean; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SpatialReference; } interface SpatialReferenceProperties { /** * An [image coordinate system](https://doc.geoscene.cn/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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#imageCoordinateSystem Read more...} */ imageCoordinateSystem?: any | nullish; /** * The well-known ID of a spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkid Read more...} */ wkid?: number | nullish; /** * The well-known text that defines a spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkt Read more...} */ wkt?: string | nullish; /** * The well-known text of the coordinate system as defined by OGC standard for well-known text strings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html#wkt2 Read more...} */ wkt2?: string | nullish; } /** * This class performs geodetic computations for Earth and 70+ non-Earth spheroids. * * @deprecated since version 4.33. Use [geometry operators](../spatial-analysis/intro-geometry-operators/) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html Read more...} */ interface geodesicUtils { /** * Geodetically computes the area for one or more polygons. * * @param polygons The polygons to compute the area for. * @param unit Output area units. * @deprecated since version 4.33. Use {@link module:geoscene/geometry/operators/geodeticAreaOperator geodeticAreaOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#geodesicAreas Read more...} */ geodesicAreas(polygons: Polygon[], unit?: AreaUnit): number[]; /** * Computes and returns a densified polyline or polygon. * * @param geometry The input polyline or polygon. * @param maxSegmentLength The maximum length (in meters) between vertices. * @deprecated since version 4.33. Use {@link module:geoscene/geometry/operators/geodeticDensifyOperator geodeticDensifyOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#geodesicDensify Read more...} */ geodesicDensify(geometry: Polyline | Polygon, maxSegmentLength: number): Polyline | Polygon; /** * Geodetically computes the direction and distance between two known locations. * * @param from The origin location. * @param to The destination location. * @param unit Output linear units. * @deprecated since version 4.33. Use {@link module:geoscene/geometry/operators/geodeticDistanceOperator geodeticDistanceOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#geodesicDistance Read more...} */ geodesicDistance(from: Point, to: Point, unit?: LengthUnit): GeodesicDistanceResult; /** * Geodetically computes polygon perimeter or polyline length for one or more geometries. * * @param geometries The input polylines or polygons. * @param unit Output linear units. * @deprecated since version 4.33. Use {@link module:geoscene/geometry/operators/geodeticLengthOperator geodeticLengthOperator} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#geodesicLengths Read more...} */ geodesicLengths(geometries: Polyline[] | Polygon[], unit?: LengthUnit): number[]; /** * Geodetically computes the location at a defined distance and direction from a known location. * * @param point Origin location. * @param distance Distance from the origin in meters. * @param azimuth Direction from the origin in degrees. * @deprecated since version 4.33. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#pointFromDistance Read more...} */ pointFromDistance(point: Point, distance: number, azimuth: number): Point; } export const geodesicUtils: geodesicUtils; /** * Computed distance and direction between two known locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-geodesicUtils.html#GeodesicDistanceResult Read more...} */ export interface GeodesicDistanceResult { distance?: number; azimuth?: number; reverseAzimuth?: number; } export class supportGeographicTransformation { /** * Geographic transformation steps. * * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/support/GeographicTransformation#steps GeographicTransformation's steps} property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformation.html#steps Read more...} */ steps: supportGeographicTransformationStep[]; constructor(properties?: any); /** * Returns the inverse of the geographic transformation calling this method or `null` if the transformation is not invertible. * * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/support/GeographicTransformation#getInverse GeographicTransformation's getInverse()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformation.html#getInverse Read more...} */ getInverse(): supportGeographicTransformation; } export class supportGeographicTransformationStep { /** * Indicates with the geographic transformation is inverted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformationStep.html#isInverse Read more...} */ isInverse: boolean; /** * The well-known id (wkid) hat represents a known geographic transformation. * * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/support/GeographicTransformationStep#wkid GeographicTransformationStep's wkid} property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformationStep.html#wkid Read more...} */ wkid: number; /** * The well-known text (wkt) that represents a known geographic transformation. * * @deprecated since version 4.32. Use the {@link module:geoscene/geometry/operators/support/GeographicTransformationStep#wkt GeographicTransformationStep's wkt} property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformationStep.html#wkt Read more...} */ wkt: string | nullish; 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. * * @deprecated since version 4.32. Use {@link module:geoscene/geometry/operators/support/GeographicTransformationStep#getInverse GeographicTransformationStep's getInverse()} method instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-GeographicTransformationStep.html#getInverse Read more...} */ getInverse(): supportGeographicTransformationStep; } /** * Provides utility methods for working with GeoScene JSON geometry objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-jsonUtils.html Read more...} */ interface jsonUtils { /** * Creates a new instance of an appropriate {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-jsonUtils.html#fromJSON Read more...} */ fromJSON(json: any | nullish): GeometryUnion | nullish; /** * Returns the type for a given geometry in the JSON format used by GeoScene. * * @param geometry The input geometry object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-jsonUtils.html#getJsonType Read more...} */ getJsonType(geometry: GeometryUnion | nullish): string | nullish; } export const jsonUtils: jsonUtils; export class MeshComponent extends Accessor { /** * Specifies a name of the component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#name Read more...} */ name: string | nullish; /** * Specifies the type of normals used for lighting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#shading Read more...} */ shading: "source" | "flat" | "smooth"; /** * The MeshComponent class is used to apply one or more materials to * a single {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html Mesh}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html Read more...} */ constructor(properties?: MeshComponentProperties); /** * A flat array of indices that refer to vertices in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributes vertexAttributes} of the * mesh to which the component belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#faces Read more...} */ get faces(): Uint32Array | nullish; set faces(value: Uint32Array | nullish | number[] | Uint16Array); /** * The material determines how the component is visualized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#material Read more...} */ get material(): MeshMaterial | MeshMaterialMetallicRoughness | nullish; set material(value: MeshMaterialProperties | MeshMaterialMetallicRoughnessProperties | nullish); /** * Creates a deep clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#clone Read more...} */ clone(): MeshComponent; } interface MeshComponentProperties { /** * A flat array of indices that refer to vertices in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html#vertexAttributes vertexAttributes} of the * mesh to which the component belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#faces Read more...} */ faces?: Uint32Array | nullish | number[] | Uint16Array; /** * The material determines how the component is visualized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#material Read more...} */ material?: MeshMaterialProperties | MeshMaterialMetallicRoughnessProperties | nullish; /** * Specifies a name of the component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#name Read more...} */ name?: string | nullish; /** * Specifies the type of normals used for lighting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html#shading Read more...} */ shading?: "source" | "flat" | "smooth"; } export interface MeshGeoreferencedVertexSpace extends Accessor, JSONSupport, Clonable { } export class MeshGeoreferencedVertexSpace { /** * Origin of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#origin Read more...} */ origin: number[] | nullish; /** * Type of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#type Read more...} */ readonly type: "georeferenced"; /** * A mesh vertex space indicating that mesh vertices are either absolute georeferenced map coordinates or relative * offsets in map space to a fully georeferenced * origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html Read more...} */ constructor(properties?: MeshGeoreferencedVertexSpaceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeshGeoreferencedVertexSpace; } interface MeshGeoreferencedVertexSpaceProperties { /** * Origin of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshGeoreferencedVertexSpace.html#origin Read more...} */ origin?: number[] | nullish; } export interface MeshLocalVertexSpace extends Accessor, JSONSupport, Clonable { } export class MeshLocalVertexSpace { /** * Origin of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#origin Read more...} */ origin: number[]; /** * Type of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html Read more...} */ constructor(properties?: MeshLocalVertexSpaceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeshLocalVertexSpace; } interface MeshLocalVertexSpaceProperties { /** * Origin of the vertex space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshLocalVertexSpace.html#origin Read more...} */ origin?: number[]; } export class MeshMaterial extends Accessor { /** * Specifies how transparency on the object is handled. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#alphaCutoff Read more...} */ alphaCutoff: number; /** * Specifies how transparency on the object is handled. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#alphaMode Read more...} */ alphaMode: "auto" | "blend" | "opaque" | "mask"; /** * Specifies whether both sides of each triangle are displayed, or only the front sides. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#doubleSided Read more...} */ doubleSided: boolean; /** * The material determines how a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html MeshComponent} is visualized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html Read more...} */ constructor(properties?: MeshMaterialProperties); /** * Specifies a single, uniform color for the mesh component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Specifies a texture from which to get color information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#colorTexture Read more...} */ get colorTexture(): MeshTexture | nullish; set colorTexture(value: | MeshTextureProperties | nullish | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | string); /** * A transformation of UV mesh coordinates used to sample the color texture. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#colorTextureTransform Read more...} */ get colorTextureTransform(): MeshTextureTransform | nullish; set colorTextureTransform(value: MeshTextureTransformProperties | nullish); /** * Specifies a texture from which to get normal information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#normalTexture Read more...} */ get normalTexture(): MeshTexture | nullish; set normalTexture(value: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string); /** * A transformation of UV mesh coordinates used to sample the normal texture. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#normalTextureTransform Read more...} */ get normalTextureTransform(): MeshTextureTransform | nullish; set normalTextureTransform(value: MeshTextureTransformProperties | nullish); } interface MeshMaterialProperties { /** * Specifies how transparency on the object is handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#alphaCutoff Read more...} */ alphaCutoff?: number; /** * Specifies how transparency on the object is handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#alphaMode Read more...} */ alphaMode?: "auto" | "blend" | "opaque" | "mask"; /** * Specifies a single, uniform color for the mesh component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#color Read more...} */ color?: ColorProperties | nullish; /** * Specifies a texture from which to get color information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#colorTexture Read more...} */ colorTexture?: | MeshTextureProperties | nullish | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the color texture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#colorTextureTransform Read more...} */ colorTextureTransform?: MeshTextureTransformProperties | nullish; /** * Specifies whether both sides of each triangle are displayed, or only the front sides. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#doubleSided Read more...} */ doubleSided?: boolean; /** * Specifies a texture from which to get normal information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#normalTexture Read more...} */ normalTexture?: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the normal texture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html#normalTextureTransform Read more...} */ normalTextureTransform?: MeshTextureTransformProperties | nullish; } export class MeshMaterialMetallicRoughness extends MeshMaterial { /** * Specifies how much the material behaves like a metal. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#metallic Read more...} */ metallic: number; /** * Indicates how rough the surface of the material is. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#roughness Read more...} */ roughness: number; /** * A material determines how a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html MeshComponent} is visualized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html Read more...} */ constructor(properties?: MeshMaterialMetallicRoughnessProperties); /** * Specifies a single, uniform emissive color for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html MeshComponent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveColor Read more...} */ get emissiveColor(): Color | nullish; set emissiveColor(value: ColorProperties | nullish); /** * Specifies a texture from which to get emissive color information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTexture Read more...} */ get emissiveTexture(): MeshTexture | nullish; set emissiveTexture(value: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string); /** * A transformation of UV mesh coordinates used to sample the emissive texture. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTextureTransform Read more...} */ get emissiveTextureTransform(): MeshTextureTransform | nullish; set emissiveTextureTransform(value: MeshTextureTransformProperties | nullish); /** * Specifies a texture from which to get the combined metallic/roughness information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#metallicRoughnessTexture Read more...} */ get metallicRoughnessTexture(): MeshTexture | nullish; set metallicRoughnessTexture(value: | MeshTextureProperties | nullish | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | string); /** * Allows to specify a texture to get the occlusion information from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTexture Read more...} */ get occlusionTexture(): MeshTexture | nullish; set occlusionTexture(value: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string); /** * A transformation of UV mesh coordinates used to sample the occlusion texture. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTextureTransform Read more...} */ get occlusionTextureTransform(): MeshTextureTransform | nullish; set occlusionTextureTransform(value: MeshTextureTransformProperties | nullish); } interface MeshMaterialMetallicRoughnessProperties extends MeshMaterialProperties { /** * Specifies a single, uniform emissive color for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshComponent.html MeshComponent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveColor Read more...} */ emissiveColor?: ColorProperties | nullish; /** * Specifies a texture from which to get emissive color information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTexture Read more...} */ emissiveTexture?: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the emissive texture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#emissiveTextureTransform Read more...} */ emissiveTextureTransform?: MeshTextureTransformProperties | nullish; /** * Specifies how much the material behaves like a metal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#metallic Read more...} */ metallic?: number; /** * Specifies a texture from which to get the combined metallic/roughness information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#metallicRoughnessTexture Read more...} */ metallicRoughnessTexture?: | MeshTextureProperties | nullish | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | string; /** * Allows to specify a texture to get the occlusion information from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTexture Read more...} */ occlusionTexture?: | MeshTextureProperties | nullish | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageData | string; /** * A transformation of UV mesh coordinates used to sample the occlusion texture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#occlusionTextureTransform Read more...} */ occlusionTextureTransform?: MeshTextureTransformProperties | nullish; /** * Indicates how rough the surface of the material is. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html#roughness Read more...} */ roughness?: number; } export class MeshTexture extends Accessor { /** * A direct reference to the image or video data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#data Read more...} */ data: HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | CompressedTextureData | nullish; /** * Indicates whether the image data should be interpreted as being semi-transparent. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#transparent Read more...} */ transparent: boolean; /** * The url to the image resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#url Read more...} */ url: string | nullish; /** * Specifies how uv coordinates outside the [0, 1] range are handled. * * @default "repeat" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#wrap Read more...} */ wrap: "clamp" | "repeat" | "mirror" | SeparableWrapModes; /** * MeshTexture represents image data to be used for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterial.html MeshMaterial} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshMaterialMetallicRoughness.html MeshMaterialMetallicRoughness}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html Read more...} */ constructor(properties?: MeshTextureProperties); /** * Creates a deep clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#clone Read more...} */ clone(): MeshTexture; } interface MeshTextureProperties { /** * A direct reference to the image or video data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#data Read more...} */ data?: HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | CompressedTextureData | nullish; /** * Indicates whether the image data should be interpreted as being semi-transparent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#transparent Read more...} */ transparent?: boolean; /** * The url to the image resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#url Read more...} */ url?: string | nullish; /** * Specifies how uv coordinates outside the [0, 1] range are handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#wrap Read more...} */ wrap?: "clamp" | "repeat" | "mirror" | SeparableWrapModes; } /** * The definition of compressed texture data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#CompressedTextureData Read more...} */ export interface CompressedTextureData { type: "encoded-mesh-texture"; encoding: "image/ktx2"; data: Uint8Array; } /** * A separable wrap configuration for horizontal and vertical wrapping modes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html#SeparableWrapModes Read more...} */ export interface SeparableWrapModes { horizontal: "clamp" | "repeat" | "mirror"; vertical: "clamp" | "repeat" | "mirror"; } export interface MeshTextureTransform extends Accessor, Clonable { } export class MeshTextureTransform { /** * The offset of the UV coordinate origin as a factor of the texture dimensions. * * @default [0, 0] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#offset Read more...} */ offset: number[]; /** * The rotation of the UV coordinates in degrees, counter-clockwise around the origin. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#rotation Read more...} */ rotation: number; /** * The scale factor applied to the components of the UV coordinates. * * @default [1, 1] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#scale Read more...} */ scale: number[]; /** * MeshTextureTransform represents a transformation of UV mesh coordinates used to sample a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTexture.html MeshTexture}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html Read more...} */ constructor(properties?: MeshTextureTransformProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#clone Read more...} */ clone(): this; } interface MeshTextureTransformProperties { /** * The offset of the UV coordinate origin as a factor of the texture dimensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#offset Read more...} */ offset?: number[]; /** * The rotation of the UV coordinates in degrees, counter-clockwise around the origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#rotation Read more...} */ rotation?: number; /** * The scale factor applied to the components of the UV coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTextureTransform.html#scale Read more...} */ scale?: number[]; } export interface MeshTransform extends Accessor, JSONSupport { } export class MeshTransform { /** * Rotation angle in degrees. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#rotationAngle Read more...} */ rotationAngle: number; /** * Axis of rotation. * * @default [0, 0, 1] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#rotationAxis Read more...} */ rotationAxis: number[]; /** * Scale. * * @default [1, 1, 1] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#scale Read more...} */ scale: number[]; /** * Translation. * * @default [0, 0, 0] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#translation Read more...} */ translation: number[]; /** * A mesh transform. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html Read more...} */ constructor(properties?: MeshTransformProperties); /** * Creates a deep clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#clone Read more...} */ clone(): MeshTransform; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeshTransform; } interface MeshTransformProperties { /** * Rotation angle in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#rotationAngle Read more...} */ rotationAngle?: number; /** * Axis of rotation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#rotationAxis Read more...} */ rotationAxis?: number[]; /** * Scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#scale Read more...} */ scale?: number[]; /** * Translation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-MeshTransform.html#translation Read more...} */ translation?: number[]; } /** * Various utilities and convenience functions for working with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html Mesh} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html Read more...} */ interface meshUtils { /** * Converts a mesh to a new vertex space. * * @param mesh the mesh geometry to convert. * @param targetVertexSpace the vertex space to convert to. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#convertVertexSpace Read more...} */ convertVertexSpace(mesh: Mesh, targetVertexSpace: MeshGeoreferencedVertexSpace | MeshLocalVertexSpace, options?: meshUtilsConvertVertexSpaceOptions): Promise; /** * Creates an elevation sampler from a mesh. * * @param mesh The mesh geometry used to create the elevation sampler. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#createElevationSampler Read more...} */ createElevationSampler(mesh: Mesh, options?: meshUtilsCreateElevationSamplerOptions): Promise; /** * Creates a mesh geometry by sampling elevation data from an elevation service on a regular grid. * * @param source The source from which to query the elevation data. * @param extent The extent from which to create the mesh. * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#createFromElevation Read more...} */ createFromElevation(source: ElevationLayer | Ground | ElevationSampler, extent: Extent, options?: meshUtilsCreateFromElevationOptions): Promise; /** * Georeferences vertices specified in a Cartesian coordinate system. * * @param vertexAttributes The position and normal buffers to georeference. * @param location The location at which to georeference the position and normal buffers. * @param options Additional options. * @deprecated since version 4.30. Use [`convertVertexSpace`](#convertVertexSpace) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#georeference Read more...} */ georeference(vertexAttributes: VertexAttributes, location: Point, options?: meshUtilsGeoreferenceOptions): VertexAttributes | nullish; /** * Merges multiple meshes into a single mesh. * * @param geometries One or more meshes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#merge Read more...} */ merge(geometries: Mesh[]): Mesh | nullish; /** * Projects georeferenced vertices to a Cartesian coordinate system. * * @param vertexAttributes The georeferenced position and normal buffers. * @param location The location to which the position and normal buffers are georeferenced. * @param options Additional options. * @deprecated since version 4.30. Use [`convertVertexSpace`](#convertVertexSpace) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#ungeoreference Read more...} */ ungeoreference(vertexAttributes: VertexAttributes, location: Point, options?: meshUtilsUngeoreferenceOptions): VertexAttributes | nullish; } export const meshUtils: meshUtils; export interface meshUtilsConvertVertexSpaceOptions { signal?: AbortSignal | nullish; } export interface meshUtilsCreateElevationSamplerOptions { noDataValue?: number; } export interface meshUtilsCreateFromElevationOptions { demResolution?: number | string; signal?: AbortSignal | nullish; } export interface meshUtilsGeoreferenceOptions { geographic?: boolean; unit?: LengthUnit; } export interface meshUtilsUngeoreferenceOptions { geographic?: boolean; unit?: LengthUnit; } /** * Represents the position and normal vertex attribute buffers of a mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-meshUtils.html#VertexAttributes Read more...} */ export interface VertexAttributes { position: Float64Array; normal?: Float32Array | nullish; tangent?: Float32Array | nullish; } /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-normalizeUtils.html Read more...} */ interface normalizeUtils { /** * Returns an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} over the dateline that is smaller than the normalized width if it visually contains the * geometry. * * @param geometry The geometry used to create the denormalized extent. The geometry should be a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline}, or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multipoint} geometry. This method returns `null` if a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multipoint} with only one point is used as the input geometry. It returns a cloned extent if an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} is used as the input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-normalizeUtils.html#getDenormalizedExtent Read more...} */ getDenormalizedExtent(geometry: GeometryUnion | nullish): Extent | nullish; /** * Normalizes geometries that intersect the central meridian or fall outside the * world extent so they stay within the coordinate system of the view. * * @param geometries An array of geometries to normalize. * @param url A geometry service URL used to perform the normalization. If this value is `null` then the default geometry service URL in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#geometryServiceUrl geosceneConfig.geometryServiceUrl} is used. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-normalizeUtils.html#normalizeCentralMeridian Read more...} */ normalizeCentralMeridian(geometries: (GeometryUnion | Mesh | nullish)[] | GeometryUnion | Mesh, url?: string | null, requestOptions?: RequestOptions): Promise<(GeometryUnion | Mesh | nullish)[]>; } export const normalizeUtils: normalizeUtils; /** * Converts Web Mercator coordinates to geographic coordinates and vice versa. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html Read more...} */ interface webMercatorUtils { /** * Returns `true` if the `source` spatial reference can be projected to the `target` spatial reference with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#project project()} function, or * if the `source` and `target` are the same {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference}. * * @param source The input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} or an object with `spatialReference` property such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * @param target The target {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} or an object with `spatialReference` property such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#canProject Read more...} */ canProject(source: SpatialReference | any, target: SpatialReference | any): boolean; /** * Converts a geometry from geographic units (wkid: 4326) to Web Mercator units (wkid: 3857). * * @param geometry The input geometry to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#geographicToWebMercator Read more...} */ geographicToWebMercator(geometry: GeometryUnion): GeometryUnion; /** * Translates the given latitude and longitude (decimal degree) values to Web Mercator XY values. * * @param long The longitude value to convert. * @param lat The latitude value to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#lngLatToXY Read more...} */ lngLatToXY(long: number, lat: number): number[]; /** * Projects the geometry clientside (if possible). * * @param geometry The input geometry. * @param spatialReference The target {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} or an object with `spatialReference` property such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#project Read more...} */ project(geometry: GeometryUnion | nullish, spatialReference: SpatialReference | any): GeometryUnion | nullish; /** * Converts a geometry from Web Mercator units (wkid: 3857) to geographic units (wkid: 4326). * * @param geometry The input geometry to convert. * @param isLinear Indicates whether to work with linear values, i.e., do not normalize. By default, this conversion method normalizes xmin and xmax values. If this is not desired, specify this value as `true`. Default value is `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#webMercatorToGeographic Read more...} */ webMercatorToGeographic(geometry: GeometryUnion, isLinear?: boolean): GeometryUnion; /** * Translates the given Web Mercator coordinates to Longitude and Latitude values (decimal degrees). * * @param x The X coordinate value to convert. * @param y The Y coordinate value to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-support-webMercatorUtils.html#xyToLngLat Read more...} */ xyToLngLat(x: number, y: number): number[]; } export const webMercatorUtils: webMercatorUtils; /** * Extent. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Extent} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Extent Read more...} */ export type geometryExtent = Extent; /** * Geometry types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~GeometryUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Geometry Read more...} */ export type geometryGeometry = Extent | Multipoint | Point | Polygon | Polyline | Mesh; /** * Multipoint. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Multipoint} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Multipoint Read more...} */ export type geometryMultipoint = Multipoint; /** * Point. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Point} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Point Read more...} */ export type geometryPoint = Point; /** * Polygon. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Polygon} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Polygon Read more...} */ export type geometryPolygon = Polygon; /** * Polyline. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/Polyline} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#Polyline Read more...} */ export type geometryPolyline = Polyline; /** * Spatial Reference. * * @deprecated since version 4.32. Import {@link module:geoscene/geometry/SpatialReference} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry.html#SpatialReference Read more...} */ export type geometrySpatialReference = SpatialReference; export interface Graphic extends Accessor, JSONSupport, Clonable { } export class Graphic { /** * The aggregateGeometries contains spatial aggregation geometries when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType statistics} query is executed with * `envelope-aggregate`, `centroid-aggregate` and/or `convex-hull-aggregate` statistics type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#aggregateGeometries Read more...} */ aggregateGeometries: any | nullish; /** * Name-value pairs of fields and field values associated with the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#attributes Read more...} */ attributes: any; /** * Indicates whether the graphic refers to an aggregate, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html cluster} graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#isAggregate Read more...} */ readonly isAggregate: boolean; /** * If applicable, references the layer in which the graphic is stored. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#layer Read more...} */ layer: Layer | SubtypeSublayer | Sublayer | BuildingComponentSublayer | nullish; /** * Returns information about the origin of a graphic if applicable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#origin Read more...} */ origin: GraphicOrigin | nullish; /** * Indicates the visibility of the graphic. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#visible Read more...} */ visible: boolean; /** * A Graphic is a vector representation of real world geographic phenomena. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Read more...} */ constructor(properties?: GraphicProperties); /** * The geometry that defines the graphic's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} * when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Symbol} for the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#symbol Read more...} */ get symbol(): SymbolUnion | nullish; set symbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#clone Read more...} */ clone(): this; /** * Returns the value of the specified attribute. * * @param name The name of the attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#getAttribute Read more...} */ getAttribute(name: string): any; /** * Returns the popup template applicable for the graphic. * * @param defaultPopupTemplateEnabled Whether support for default popup templates is enabled. When true, a default popup template may be created automatically if neither the graphic nor its layer have a popup template defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#getEffectivePopupTemplate Read more...} */ getEffectivePopupTemplate(defaultPopupTemplateEnabled?: boolean): PopupTemplate | nullish; /** * Returns the Global ID of the feature associated with the graphic, if it exists. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#getGlobalId Read more...} */ getGlobalId(): string | nullish; /** * Returns the Object ID of the feature associated with the graphic, if it exists. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#getObjectId Read more...} */ getObjectId(): number | string | nullish; /** * Sets a new value to the specified attribute. * * @param name The name of the attribute to set. * @param newValue The new value to set on the named attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#setAttribute Read more...} */ setAttribute(name: string, newValue: any): void; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Graphic; } interface GraphicProperties { /** * The aggregateGeometries contains spatial aggregation geometries when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType statistics} query is executed with * `envelope-aggregate`, `centroid-aggregate` and/or `convex-hull-aggregate` statistics type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#aggregateGeometries Read more...} */ aggregateGeometries?: any | nullish; /** * Name-value pairs of fields and field values associated with the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#attributes Read more...} */ attributes?: any; /** * The geometry that defines the graphic's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * If applicable, references the layer in which the graphic is stored. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#layer Read more...} */ layer?: Layer | SubtypeSublayer | Sublayer | BuildingComponentSublayer | nullish; /** * Returns information about the origin of a graphic if applicable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#origin Read more...} */ origin?: GraphicOrigin | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} * when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Symbol} for the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#symbol Read more...} */ symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * Indicates the visibility of the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#visible Read more...} */ visible?: boolean; } /** * Information about an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#origin origin} of a graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#GraphicOrigin Read more...} */ export type GraphicOrigin = VectorTileOrigin; /** * Origin information about a graphic returned as a result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html VectorTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#VectorTileOrigin Read more...} */ export interface VectorTileOrigin { type: "vector-tile"; layerId: string; layerIndex: number; layer: VectorTileLayer; } export interface Ground extends Accessor, Loadable, JSONSupport { } export class Ground { /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#opacity Read more...} */ opacity: number; /** * The Ground class contains properties that specify how the ground surface is * displayed in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html Read more...} */ constructor(properties?: GroundProperties); /** * A collection of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayers} * that define the elevation or terrain that makes up the ground surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties); /** * Specifies the user navigation constraints relative to * the ground surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#navigationConstraint Read more...} */ get navigationConstraint(): GroundNavigationConstraint | nullish; set navigationConstraint(value: GroundNavigationConstraintProperties | nullish); /** * The color of the ground surface, displayed underneath the basemap. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#surfaceColor Read more...} */ get surfaceColor(): Color | nullish; set surfaceColor(value: ColorProperties | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#clone Read more...} */ 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. * * @param extent The extent for which to create the sampler. * @param options Additional sampler options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#createElevationSampler Read more...} */ createElevationSampler(extent: Extent, options?: GroundCreateElevationSamplerOptions): Promise; /** * Destroys the ground and its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#layers layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#destroy Read more...} */ destroy(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Loads all the externally loadable resources associated with the ground. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#loadAll Read more...} */ loadAll(): Promise; /** * Query the ground layer services for elevation values for the given geometry. * * @param geometry The geometry to sample. * @param options Additional query options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#queryElevation Read more...} */ queryElevation(geometry: Point | Multipoint | Polyline, options?: GroundQueryElevationOptions): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#toJSON Read more...} */ toJSON(): any; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Ground; } interface GroundProperties extends LoadableProperties { /** * A collection of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayers} * that define the elevation or terrain that makes up the ground surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#layers Read more...} */ layers?: CollectionProperties; /** * Specifies the user navigation constraints relative to * the ground surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#navigationConstraint Read more...} */ navigationConstraint?: GroundNavigationConstraintProperties | nullish; /** * Opacity of the ground, including surface default color and the basemap (without reference layers). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#opacity Read more...} */ opacity?: number; /** * The color of the ground surface, displayed underneath the basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#surfaceColor Read more...} */ surfaceColor?: ColorProperties | nullish; } /** * Object returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#queryElevation queryElevation()} promise resolves:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#ElevationQueryResult Read more...} */ export interface ElevationQueryResult { geometry: Point | Multipoint | Polyline; sampleInfo?: ElevationQueryResultSampleInfo[]; noDataValue: number | nullish; } export interface GroundCreateElevationSamplerOptions { demResolution?: number | string; noDataValue?: number; signal?: AbortSignal | nullish; } export interface GroundNavigationConstraintProperties { type?: "stay-above" | "none"; } export interface GroundNavigationConstraint extends AnonymousAccessor { type: "stay-above" | "none"; } export interface GroundQueryElevationOptions { demResolution?: number | string; returnSampleInfo?: boolean; noDataValue?: number; signal?: AbortSignal | nullish; } export interface ElevationQueryResultSampleInfo { demResolution: number; source?: ElevationLayer | BaseElevationLayer; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#expires Read more...} */ expires: number | nullish; /** * Indicates that this credential was created to access the [GeoScene Server Administrator REST API](https://doc.geoscene.cn/rest/enterprise-administration/server/overview/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#isAdmin Read more...} */ isAdmin: boolean; /** * The Identity Manager's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#setOAuthRedirectionHandler setOAuthRedirectionHandler} * returns an object that contains a `state` property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#oAuthState Read more...} */ oAuthState: any; /** * The scope of the credential. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#scope Read more...} */ scope: "portal" | "server"; /** * The server url. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#server Read more...} */ server: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#ssl Read more...} */ ssl: boolean; /** * Token generated by the token service using the specified userId and password. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#token Read more...} */ token: string; /** * User associated with the Credential object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#userId Read more...} */ userId: string; constructor(properties?: CredentialProperties); /** * Destroys the credential. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#destroy Read more...} */ destroy(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Generates a new token and updates the Credential's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#token token} property with * the newly acquired token. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#refreshToken Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#expires Read more...} */ expires?: number | nullish; /** * Indicates that this credential was created to access the [GeoScene Server Administrator REST API](https://doc.geoscene.cn/rest/enterprise-administration/server/overview/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#isAdmin Read more...} */ isAdmin?: boolean; /** * The Identity Manager's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#setOAuthRedirectionHandler setOAuthRedirectionHandler} * returns an object that contains a `state` property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#oAuthState Read more...} */ oAuthState?: any; /** * The scope of the credential. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#scope Read more...} */ scope?: "portal" | "server"; /** * The server url. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#server Read more...} */ server?: string; /** * Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#ssl Read more...} */ ssl?: boolean; /** * Token generated by the token service using the specified userId and password. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#token Read more...} */ token?: string; /** * User associated with the Credential object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html#userId Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#dialog Read more...} */ dialog: Widget; /** * The suggested lifetime of the token in minutes. * * @default 60 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#tokenValidity Read more...} */ tokenValidity: number; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html credential} if the user has already signed in to access the given resource * and is allowed to do so when using the given application id. * * @param resUrl The resource URL. * @param appId The registered OAuth application id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#checkAppAccess Read more...} */ checkAppAccess(resUrl: string, appId: string): Promise; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html Credential} if the user has already signed in to access the given resource. * * @param resUrl The resource URL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#checkSignInStatus Read more...} */ checkSignInStatus(resUrl: string): Promise; /** * Destroys all credentials. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#destroyCredentials Read more...} */ destroyCredentials(): void; /** * Disables the use of `window.postMessage` to serve authentication requests that were enabled by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#enablePostMessageAuth enablePostMessageAuth}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#disablePostMessageAuth Read more...} */ disablePostMessageAuth(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Enables the IdentityManager to serve authentication requests for the given resource from apps running in child iframes. * * @param resUrl The resource URL. Default value is `https://www.geosceneonline.cn/geoscene/sharing/rest`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#enablePostMessageAuth Read more...} */ enablePostMessageAuth(resUrl?: string): void; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html Credential} for the resource identified by the specified url. * * @param url The URL to a server. * @param userId The userId for which you want to obtain credentials. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#findCredential Read more...} */ findCredential(url: string, userId?: string): Credential; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html OAuthInfo} configuration for the passed in Portal server URL. * * @param url The URL to a Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#findOAuthInfo Read more...} */ findOAuthInfo(url: string): OAuthInfo; /** * Returns information about the server that is hosting the specified URL. * * @param url The URL to the server * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#findServerInfo Read more...} */ findServerInfo(url: string): ServerInfo; /** * Returns an object containing a token and its expiration time. * * @param serverInfo A ServerInfo object that contains a token service URL. * @param userInfo A user info object containing a user name and password. * @param options See the table below for the structure of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#generateToken Read more...} */ generateToken(serverInfo: ServerInfo, userInfo: any, options?: IdentityManagerGenerateTokenOptions): Promise; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-Credential.html Credential} object that can be used to access the secured resource identified by the input URL. * * @param url The URL for the secure resource * @param options See the table below for the structure of the **options** object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#getCredential Read more...} */ getCredential(url: string, options?: IdentityManagerGetCredentialOptions): Promise; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Call this method during application initialization with the JSON previously obtained from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#toJSON toJSON()} method used to re-hydrate the state of IdentityManager. * * @param json The JSON obtained from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#toJSON toJSON()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#initialize Read more...} */ initialize(json: any): void; /** * Indicates if the IdentityManager is busy accepting user input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#isBusy Read more...} */ isBusy(): boolean; /** * Registers OAuth 2.0 configurations. * * @param oAuthInfos An array of OAuthInfo objects that defines the OAuth configurations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#registerOAuthInfos Read more...} */ registerOAuthInfos(oAuthInfos: OAuthInfo[]): void; /** * Register secure servers and the token endpoints. * * @param serverInfos An array of ServerInfos objects that defines the secure service and token endpoint. The IdentityManager makes its best guess to determine the location of the secure server and token endpoint. Therefore, in most cases calling this method is not necessary. However, if the location of your server or token endpoint is not standard, use this method to register the location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#registerServers Read more...} */ registerServers(serverInfos: ServerInfo[]): void; /** * Registers the given OAuth 2.0 access token or GeoScene Server token with the IdentityManager. * * @param properties See the table below for the structure of the **properties** object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#registerToken Read more...} */ registerToken(properties: IdentityManagerRegisterTokenProperties): void; /** * Once a user successfully logs in, they are redirected back to the application. * * @param handlerFunction When called, the callback passed to `setOAuthRedirectionHandler` receives an object containing the redirection properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#setOAuthRedirectionHandler Read more...} */ setOAuthRedirectionHandler(handlerFunction: HandlerCallback): void; /** * Use this method in the popup callback page to pass the token and other values back to the IdentityManager. * * @param hash The token information in addition to any other values needed to be passed back to the IdentityManager. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#setOAuthResponseHash Read more...} */ 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. * * @param handlerFunction The function to call when the protocol is mismatched. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#setProtocolErrorHandler Read more...} */ setProtocolErrorHandler(handlerFunction: IdentityManagerSetProtocolErrorHandlerHandlerFunction): void; /** * Return properties of this object in JSON format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-IdentityManager.html#toJSON Read more...} */ 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 = (info: HandlerCallbackInfo) => void; export interface IdentityManagerGenerateTokenOptions { serverUrl: string; token: string; ssl: boolean; } export interface IdentityManagerGetCredentialOptions { error?: Error; oAuthPopupConfirmation?: boolean; token?: string; } export interface IdentityManagerRegisterTokenProperties { expires?: number; server: string; ssl?: boolean; token: string; userId?: string; } export interface IdentityManagerSetProtocolErrorHandlerHandlerFunction { resourceUrl: string; serverInfo: ServerInfo; } export interface HandlerCallbackInfo { authorizeParams: HandlerCallbackInfoAuthorizeParams; authorizeUrl: string; oAuthInfo: OAuthInfo; resourceUrl: string; serverInfo: ServerInfo; } export interface HandlerCallbackInfoAuthorizeParams { client_id: string; response_type: string; state: string; expiration: number; locale: string; redirect_uri: string; } export interface OAuthInfo extends Accessor, JSONSupport { } export class OAuthInfo { /** * The registered application id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#appId Read more...} */ appId: string | nullish; /** * Applications with the same value will share the stored token on the same host. * * @default / (forward slash) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#authNamespace Read more...} */ authNamespace: string; /** * The number of minutes that the token is valid. * * @default 20160 (two weeks) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#expiration Read more...} */ expiration: number; /** * Set this property to specify the type of authentication to use. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#flowType Read more...} */ flowType: "auto" | "authorization-code" | "implicit"; /** * Set this property to `true` to force the user to sign in with the id in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#userId userId}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#forceUserId Read more...} */ forceUserId: boolean; /** * The locale for the OAuth sign-in page. * * @default // Based on your browser/OS and the organization locale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#locale Read more...} */ locale: string | nullish; /** * The minimum time in minutes before a saved token is due to expire that * should still be considered valid for use. * * @default 30 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#minTimeUntilExpiration Read more...} */ minTimeUntilExpiration: number; /** * Set to `true` to show the OAuth sign-in page in a popup window. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popup Read more...} */ popup: boolean; /** * Applicable if working with the popup user-login workflow. * * @default "oauth-callback.html" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popupCallbackUrl Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popupWindowFeatures Read more...} */ popupWindowFeatures: string; /** * The URL to either an GeoScene Online or an GeoScene Enterprise portal. * * @default "https://www.geosceneonline.cn/geoscene" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#portalUrl Read more...} */ portalUrl: string; /** * Set this property to `true` when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popup popup} is `false` in order to have the window's location hash value restored after signing in. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#preserveUrlHash Read more...} */ preserveUrlHash: boolean; /** * The user id used when `forceUserId` is `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#userId Read more...} */ userId: string | nullish; /** * This class contains information about an OAuth 2.0 configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html Read more...} */ constructor(properties?: OAuthInfoProperties); /** * Creates a copy of the OAuthInfo object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#clone Read more...} */ clone(): OAuthInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): OAuthInfo; } interface OAuthInfoProperties { /** * The registered application id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#appId Read more...} */ appId?: string | nullish; /** * Applications with the same value will share the stored token on the same host. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#authNamespace Read more...} */ authNamespace?: string; /** * The number of minutes that the token is valid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#expiration Read more...} */ expiration?: number; /** * Set this property to specify the type of authentication to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#flowType Read more...} */ flowType?: "auto" | "authorization-code" | "implicit"; /** * Set this property to `true` to force the user to sign in with the id in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#userId userId}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#forceUserId Read more...} */ forceUserId?: boolean; /** * The locale for the OAuth sign-in page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#locale Read more...} */ locale?: string | nullish; /** * The minimum time in minutes before a saved token is due to expire that * should still be considered valid for use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#minTimeUntilExpiration Read more...} */ minTimeUntilExpiration?: number; /** * Set to `true` to show the OAuth sign-in page in a popup window. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popup Read more...} */ popup?: boolean; /** * Applicable if working with the popup user-login workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popupCallbackUrl Read more...} */ popupCallbackUrl?: string; /** * The window features passed to * [window.open()](https://developer.mozilla.org/en-US/docs/Web/API/Window/open). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popupWindowFeatures Read more...} */ popupWindowFeatures?: string; /** * The URL to either an GeoScene Online or an GeoScene Enterprise portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#portalUrl Read more...} */ portalUrl?: string; /** * Set this property to `true` when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#popup popup} is `false` in order to have the window's location hash value restored after signing in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#preserveUrlHash Read more...} */ preserveUrlHash?: boolean; /** * The user id used when `forceUserId` is `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-OAuthInfo.html#userId Read more...} */ userId?: string | nullish; } export interface ServerInfo extends Accessor, JSONSupport { } export class ServerInfo { /** * The token service URL used to generate tokens for GeoScene Server Admin resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#adminTokenServiceUrl Read more...} */ adminTokenServiceUrl: string | nullish; /** * Version of the GeoScene Server or Portal deployed on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#currentVersion Read more...} */ currentVersion: number | nullish; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server server} is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#hasPortal Read more...} */ hasPortal: boolean | nullish; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server server} is an [GeoScene Server](https://enterprise.geosceneonline.cn/zh/server/latest/get-started/windows/what-is-geoscene-for-server-.htm) instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#hasServer Read more...} */ hasServer: boolean | nullish; /** * The server URL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server Read more...} */ server: string | nullish; /** * Validity of short-lived token in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#shortLivedTokenValidity Read more...} */ shortLivedTokenValidity: number | nullish; /** * The token service URL used to generate tokens for the secured resources on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#tokenServiceUrl Read more...} */ tokenServiceUrl: string | nullish; /** * Indicates whether the server is configured to work with web tier authentication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#webTierAuth Read more...} */ webTierAuth: boolean | nullish; /** * This class contains information about an GeoScene Server and its token endpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html Read more...} */ constructor(properties?: ServerInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ServerInfo; } interface ServerInfoProperties { /** * The token service URL used to generate tokens for GeoScene Server Admin resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#adminTokenServiceUrl Read more...} */ adminTokenServiceUrl?: string | nullish; /** * Version of the GeoScene Server or Portal deployed on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#currentVersion Read more...} */ currentVersion?: number | nullish; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server server} is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#hasPortal Read more...} */ hasPortal?: boolean | nullish; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server server} is an [GeoScene Server](https://enterprise.geosceneonline.cn/zh/server/latest/get-started/windows/what-is-geoscene-for-server-.htm) instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#hasServer Read more...} */ hasServer?: boolean | nullish; /** * The server URL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#server Read more...} */ server?: string | nullish; /** * Validity of short-lived token in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#shortLivedTokenValidity Read more...} */ shortLivedTokenValidity?: number | nullish; /** * The token service URL used to generate tokens for the secured resources on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#tokenServiceUrl Read more...} */ tokenServiceUrl?: string | nullish; /** * Indicates whether the server is configured to work with web tier authentication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-identity-ServerInfo.html#webTierAuth Read more...} */ webTierAuth?: boolean | nullish; } /** * This module provides the ability to set the app locale along with date and number formatting methods and supporting utilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html Read more...} */ interface intl { /** * Converts a [web map date format string](https://doc.geoscene.cn/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. * * @param format A web map date format string to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#convertDateFormatToIntlOptions Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#NumberFormat NumberFormat} to an [Intl.NumberFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat#Parameters) object. * * @param format The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#NumberFormat NumberFormat} to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#convertNumberFormatToIntlOptions Read more...} */ convertNumberFormatToIntlOptions(format?: NumberFormat): Intl.NumberFormatOptions; /** * Creates a message bundle loader specialized in loading translation files as JSON files. * * @param params The configuration of the loader. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#createJSONLoader Read more...} */ createJSONLoader(params: intlCreateJSONLoaderParams): MessageBundleLoader; /** * Loads a localized message bundle used with the current API locale. * * @param bundleId The identifier of the message bundle, passed to the loader registered with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#registerMessageBundleLoader registerMessageBundleLoader}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#fetchMessageBundle Read more...} */ fetchMessageBundle(bundleId: string): Promise; /** * Formats a `Date` or `Number` value to a string in the current locale. * * @param value The [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) object, or the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC, to be formatted. * @param formatOptions Date format options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#formatDate Read more...} */ formatDate(value: Date | number, formatOptions?: Intl.DateTimeFormatOptions): string; /** * Formats a `date-only` field value to a string in the current locale. * * @param value The `date-only` field value. * @param options Date format options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#formatDateOnly Read more...} */ formatDateOnly(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Formats a `Number` value to a string in the current locale. * * @param value Number to be formatted. * @param formatOptions Number format options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#formatNumber Read more...} */ formatNumber(value: number, formatOptions?: Intl.NumberFormatOptions): string; /** * Formats a `time-only` field value to a string in the current locale. * * @param value The `time-only` field value. * @param options Time format options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#formatTimeOnly Read more...} */ formatTimeOnly(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Formats a `timestamp-offset` field value to a string in the current locale. * * @param value The `timestamp-offset` field value. * @param options Timestamp format options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#formatTimestamp Read more...} */ formatTimestamp(value: string, options?: Intl.DateTimeFormatOptions): string; /** * Returns the current locale used by the API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#getLocale Read more...} */ getLocale(): string; /** * Returns one of the known message bundle locale for an input locale. * * @param locale Any locale string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#normalizeMessageBundleLocale Read more...} */ normalizeMessageBundleLocale(locale: string): string | nullish; /** * Registers a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#LocaleChangeCallback callback} that gets notified when * the locale changes. * * @param callback A function that is fired when the locale changes. It is called with the newly-set locale after executing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#setLocale setLocale()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#onLocaleChange Read more...} */ onLocaleChange(callback: LocaleChangeCallback): Handle; /** * Provides right-to-left preference for input locale. * * @param locale The locale string to obtain the right-to-left information. The current locale is used by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#prefersRTL Read more...} */ prefersRTL(locale?: string): boolean; /** * Registers a message loader to load specified message bundles needed for translating strings. * * @param loader A message bundle loader. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#registerMessageBundleLoader Read more...} */ registerMessageBundleLoader(loader: MessageBundleLoader): any; /** * Sets the locale used by the SDK. * * @param locale The new Unicode locale identifier string, similar to the Intl APIs. If this is `undefined`, the locale is reset to its default value described in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#getLocale `getLocale()`}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#setLocale Read more...} */ setLocale(locale: string): void; /** * Use this to substitute keys in a `template` string with values from the argument `data`. * * @param template Template string to use for substitution. * @param data Data object to be substituted. * @param options Options for determining how to substitute keys in the template string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#substitute Read more...} */ substitute(template: string, data: any, options?: SubstituteOptions): string; } export const intl: intl; export type FetchMessageBundle = (bundleId: string, locale: string) => Promise; export interface intlCreateJSONLoaderParams { pattern: string | RegExp; base: string; location: string | URL | LocationFunction; } export type LocaleChangeCallback = (newLocale: string) => void; export type LocationFunction = (path: string) => string; /** * A message bundle loader is an object used to load translation strings in the user's locale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#MessageBundleLoader Read more...} */ export interface MessageBundleLoader { pattern: string | RegExp; fetchMessageBundle: FetchMessageBundle; } /** * The Web map definition for formatting numbers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#NumberFormat Read more...} */ export interface NumberFormat { digitSeparator?: boolean; places?: number; } /** * The formatting options for date values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#SubstituteDateTimeFormatOptions Read more...} */ export interface SubstituteDateTimeFormatOptions { type: "date"; intlOptions: Intl.DateTimeFormatOptions; } /** * The formatting options for numeric values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#SubstituteNumberFormatOptions Read more...} */ export interface SubstituteNumberFormatOptions { type: "number"; intlOptions: Intl.NumberFormatOptions; } /** * An object to specify substitution options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#SubstituteOptions Read more...} */ export interface SubstituteOptions { format: HashMap; } /** * Utility for retrieving the current or next version of the SDK. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-kernel.html Read more...} */ interface kernel { readonly fullVersion: string; readonly version: string; } export const kernel: kernel; export interface BaseDynamicLayer extends Layer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class BaseDynamicLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; readonly type: "base-dynamic"; /** * This class may be extended to create dynamic map layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html Read more...} */ constructor(properties?: BaseDynamicLayerProperties); /** * Adds a promise to the layer's loadable chain. * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#loadStatus status} to being {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#loaded loaded}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#addResolvingPromise Read more...} */ addResolvingPromise(promiseToLoad: Promise): void; /** * This method fetches the image for the specified extent and size. * * @param extent The extent of the view. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param width The width of the view in pixels. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param height The height of the view in pixels. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#fetchImage Read more...} */ 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. * * @param extent Extent of the view. This value is populated by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param width Width of the view in pixels. This value is populated by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param height Height of the view in pixels. This value is populated by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#getImageUrl Read more...} */ getImageUrl(extent: Extent, width: number, height: number): Promise | string; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#refresh Read more...} */ refresh(): void; 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 { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseDynamicLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; } export interface BaseDynamicLayerFetchImageOptions { signal?: AbortSignal | nullish; } 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 { readonly type: "base-elevation"; /** * BaseElevationLayer is intended to be extended for creating custom elevation layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html Read more...} */ constructor(properties?: BaseElevationLayerProperties); /** * The spatial reference of the layer. * * @default {@link module:geoscene/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); /** * Adds a promise to the layer's loadable chain. * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#loadStatus status} to being {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#loaded loaded}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#addResolvingPromise Read more...} */ addResolvingPromise(promiseToLoad: Promise): void; /** * Creates an elevation sampler for the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} by querying the service layer * for elevation data and caching it so values may be sampled quickly afterwards. * * @param extent The extent for which to create the sampler. * @param options Additional query options. See the table below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#createElevationSampler Read more...} */ createElevationSampler(extent: Extent, options?: BaseElevationLayerCreateElevationSamplerOptions): Promise; /** * Fetches a tile at the given level, row, and column present in the view. * * @param level The level of detail of the tile to fetch. * @param row The row (y) position of the tile to fetch. * @param column The column (x) position of the tile to fetch. * @param options Optional settings for the tile request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#fetchTile Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} object. * * @param level The level of detail (LOD) of the tile. * @param row The tile's row (y) position in the dataset. * @param column The tiles column (x) position in the dataset. * @param out Array for storing the tile bounds or extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#getTileBounds Read more...} */ getTileBounds(level: number, row: number, column: number, out?: number[]): number[]; /** * Queries the service layer for elevation values for the given geometry. * * @param geometry The geometry to use for sampling elevation data. * @param options Additional query options. See the table below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#queryElevation Read more...} */ queryElevation(geometry: Point | Multipoint | Polyline, options?: BaseElevationLayerQueryElevationOptions): Promise; } interface BaseElevationLayerProperties extends LayerProperties { /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties; } export interface BaseElevationLayerCreateElevationSamplerOptions { demResolution?: number | string; noDataValue?: number; } export interface BaseElevationLayerFetchTileOptions { noDataValue?: number; signal?: AbortSignal | nullish; } export interface BaseElevationLayerQueryElevationOptions { demResolution?: number | string; returnSampleInfo?: boolean; noDataValue?: number; } /** * Describes elevation contained in the pixels that comprise an elevation tile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseElevationLayer.html#ElevationTileData Read more...} */ export interface ElevationTileData { values: Float32Array; width: number; height: number; noDataValue: number; } export interface BaseTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class BaseTileLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * For {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html BaseTileLayer} the type is `base-tile`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#type Read more...} */ readonly type: "base-tile" | "bing-maps"; /** * This class may be extended to create a custom TileLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html Read more...} */ constructor(properties?: BaseTileLayerProperties); /** * The spatial reference of the layer. * * @default {@link module:geoscene/geometry/SpatialReference#WebMercator SpatialReference.WebMercator} * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); /** * Adds a Promise to the layer's loadable chain. * * @param promiseToLoad A promise that must resolve for the layer to resolve and move from the `loading` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#loadStatus status} to being {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#loaded loaded}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#addResolvingPromise Read more...} */ addResolvingPromise(promiseToLoad: Promise): void; /** * This method fetches a tile for the given level, row and column present in the view. * * @param level Level of detail of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param row The row (y) position of the tile fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param col The column (x) position of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param options Optional settings for the tile request. The options have the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#fetchTile Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} object. * * @param level The level of detail (LOD) of the tile. * @param row The tile's row (y) position in the dataset. * @param column The tiles column (x) position in the dataset. * @param out Array for storing the tile bounds or extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#getTileBounds Read more...} */ 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. * * @param level Level of detail. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param row Tile row. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param col Tile column. This value is provided by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#getTileUrl Read more...} */ getTileUrl(level: number, row: number, col: number): string | nullish; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#refresh Read more...} */ refresh(): void; 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 { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BaseTileLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties; } export interface BaseTileLayerFetchTileOptions { signal?: AbortSignal | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#bingLogo Read more...} */ readonly bingLogo: string | nullish; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Copyright information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#copyright Read more...} */ readonly copyright: string | nullish; /** * Provides culture specific map labels. * * @default "en-US" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#culture Read more...} */ culture: string; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Indicates if the layer has attribution data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#hasAttributionData Read more...} */ readonly hasAttributionData: boolean; /** * Bing Maps Key. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#key Read more...} */ key: string; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#region Read more...} */ region: string | nullish; /** * For more information on Bing map styles please visit: * https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata. * * @default "road" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#style Read more...} */ style: "road" | "aerial" | "hybrid"; readonly type: "bing-maps"; /** * This layer supports Microsoft's Bing tiled map content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html Read more...} */ 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 { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Provides culture specific map labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#culture Read more...} */ culture?: string; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Bing Maps Key. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#key Read more...} */ key?: string; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * This will alter Geopolitical disputed borders and labels to align with the specified user region. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#region Read more...} */ region?: string | nullish; /** * For more information on Bing map styles please visit: * https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BingMapsLayer.html#style Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#activeFilterId Read more...} */ activeFilterId: string | nullish; /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#sublayers sublayers} * in the BuildingSublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#allSublayers Read more...} */ readonly allSublayers: Collection; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#copyright Read more...} */ declare copyright: SceneService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#layerId Read more...} */ declare layerId: SceneService["layerId"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * An array of field names from the service to include with each feature in all sublayers. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Hierarchical structure of sublayers in a BuildingSceneLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#sublayers Read more...} */ readonly sublayers: Collection; /** * Summary statistics for all component layers in the building scene layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#summaryStatistics Read more...} */ readonly summaryStatistics: BuildingSummaryStatistics | nullish; readonly type: "building-scene"; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#url Read more...} */ declare url: SceneService["url"]; /** * The version of the scene service specification used for this service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#version Read more...} */ declare readonly version: SceneService["version"]; /** * The BuildingSceneLayer is designed for visualizing buildings with detailed interiors * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html Read more...} */ constructor(properties?: BuildingSceneLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#elevationInfo Read more...} */ get elevationInfo(): BuildingSceneLayerElevationInfo | nullish; set elevationInfo(value: BuildingSceneLayerElevationInfoProperties | nullish); /** * Collection of filters that can be used to show or hide specific features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#filters Read more...} */ get filters(): Collection; set filters(value: CollectionProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Loads the layer and all of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#loadAll Read more...} */ loadAll(): Promise; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#save Read more...} */ save(): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options additional save options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: BuildingSceneLayerSaveAsOptions): Promise; static fromJSON(json: any): BuildingSceneLayer; } interface BuildingSceneLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * The id of the currently active filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#activeFilterId Read more...} */ activeFilterId?: string | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#copyright Read more...} */ copyright?: SceneServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#elevationInfo Read more...} */ elevationInfo?: BuildingSceneLayerElevationInfoProperties | nullish; /** * Collection of filters that can be used to show or hide specific features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#filters Read more...} */ filters?: CollectionProperties; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#layerId Read more...} */ layerId?: SceneServiceProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * An array of field names from the service to include with each feature in all sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#url Read more...} */ url?: SceneServiceProperties["url"]; } export interface BuildingSceneLayerElevationInfoProperties { mode?: "absolute-height"; offset?: number | nullish; unit?: ElevationUnit | nullish; } export interface BuildingSceneLayerElevationInfo extends AnonymousAccessor { mode: "absolute-height"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface BuildingSceneLayerSaveAsOptions { folder?: PortalFolder; } export interface BuildingComponentSublayer extends BuildingSublayer, Loadable { } export class BuildingComponentSublayer { /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#fields Read more...} */ readonly fields: Field[]; /** * The name of a `global-id` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#fields field} containing * a globally unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#globalIdField Read more...} */ readonly globalIdField: string; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * @default "show" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#listMode Read more...} */ listMode: "show" | "hide"; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#objectIdField Read more...} */ readonly objectIdField: string; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#popupEnabled Read more...} */ popupEnabled: boolean; readonly type: "building-component"; /** * BuildingComponentSublayers contain 3D Object features representing building components * like doors, pipes or AC units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html Read more...} */ constructor(properties?: BuildingComponentSublayerProperties); /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates a query object that can be used to fetch features that * satisfy the component sublayer's current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression definition expression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: BuildingComponentSublayerGetFieldDomainOptions): Domain | nullish; /** * Gets field usage information. * * @param fieldName The name of the field to get usage info for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#getFieldUsageInfo Read more...} */ getFieldUsageInfo(fieldName: string): any; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns the 2D * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: BuildingComponentSublayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and * returns the number of features that satisfy the query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: BuildingComponentSublayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: BuildingComponentSublayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns an array of * ObjectIDs of the features that satisfy the input query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: BuildingComponentSublayerQueryObjectIdsOptions): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; static fromJSON(json: any): BuildingComponentSublayer; } interface BuildingComponentSublayerProperties extends BuildingSublayerProperties, LoadableProperties { /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#listMode Read more...} */ listMode?: "show" | "hide"; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; } export interface BuildingComponentSublayerGetFieldDomainOptions { feature: Graphic; } export interface BuildingComponentSublayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export class BuildingGroupSublayer extends BuildingSublayer { /** * Indicates how the sublayer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * @default "show" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingGroupSublayer.html#listMode Read more...} */ listMode: "show" | "hide" | "hide-children"; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingGroupSublayer.html#sublayers Read more...} */ readonly sublayers: Collection; readonly type: "building-group"; /** * Hierarchical group of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingGroupSublayer.html Read more...} */ constructor(properties?: BuildingGroupSublayerProperties); /** * Loads all contained sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingGroupSublayer.html#loadAll Read more...} */ loadAll(): Promise; static fromJSON(json: any): BuildingGroupSublayer; } interface BuildingGroupSublayerProperties extends BuildingSublayerProperties { /** * Indicates how the sublayer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingGroupSublayer.html#listMode Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#id Read more...} */ readonly id: number; /** * Indicates if this sublayer is empty. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#isEmpty Read more...} */ readonly isEmpty: boolean | nullish; /** * The modelName is a standard name for each sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#modelName Read more...} */ readonly modelName: string | nullish; /** * Opacity of the sublayer. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#opacity Read more...} */ opacity: number; /** * The title of the sublayer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#title Read more...} */ title: string | nullish; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates if the sublayer is visible in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#visible Read more...} */ visible: boolean; /** * BuildingSublayer is the base class for sublayers of a BuildingSceneLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html Read more...} */ constructor(properties?: BuildingSublayerProperties); static fromJSON(json: any): BuildingSublayer; } interface BuildingSublayerProperties extends IdentifiableProperties { /** * Opacity of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#opacity Read more...} */ opacity?: number; /** * The title of the sublayer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#title Read more...} */ title?: string | nullish; /** * Indicates if the sublayer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingSublayer.html#visible Read more...} */ visible?: boolean; } export interface CatalogDynamicGroupLayer extends Layer, BlendLayer, ScaleRangeLayer { } export class CatalogDynamicGroupLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers} referenced in the CatalogLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#layers Read more...} */ readonly layers: Collection; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum number of sublayers that can be visible at once in a CatalogDynamicGroupLayer. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#maximumVisibleSublayers Read more...} */ maximumVisibleSublayers: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; readonly type: "catalog-dynamic-group"; /** * CatalogDynamicGroupLayer is a sublayer of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} that displays catalog items (layers) in the current view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html Read more...} */ constructor(properties?: CatalogDynamicGroupLayerProperties); } interface CatalogDynamicGroupLayerProperties extends LayerProperties, BlendLayerProperties, ScaleRangeLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum number of sublayers that can be visible at once in a CatalogDynamicGroupLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#maximumVisibleSublayers Read more...} */ maximumVisibleSublayers?: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; } export interface CatalogFootprintLayer extends Layer, BlendLayer, ScaleRangeLayer, FeatureEffectLayer { } export class CatalogFootprintLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#apiKey Read more...} */ readonly apiKey: string | nullish; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Array of Chart Items of type WebMapWebChart available on the footprint layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#charts Read more...} */ charts: any[] | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#customParameters Read more...} */ readonly customParameters: any | nullish; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#dateFieldsTimeZone Read more...} */ readonly dateFieldsTimeZone: string | nullish; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#datesInUnknownTimezone Read more...} */ readonly datesInUnknownTimezone: any | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#definitionExpression Read more...} */ readonly definitionExpression: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#displayField Read more...} */ readonly displayField: string | nullish; /** * Indicates whether the layer supports display filters. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#displayFilterEnabled Read more...} */ readonly displayFilterEnabled: boolean; /** * Information pertaining to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#displayFilterInfo Read more...} */ readonly displayFilterInfo: DisplayFilterInfo | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#effectiveCapabilities Read more...} */ readonly effectiveCapabilities: Capabilities | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#fields Read more...} */ readonly fields: Field[] | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * Provides information on the system maintained area and length fields along with their respective units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#geometryFieldsInfo Read more...} */ readonly geometryFieldsInfo: GeometryFieldsInfo | nullish; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#geometryType Read more...} */ readonly geometryType: "polygon"; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#hasM Read more...} */ readonly hasM: boolean; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#hasZ Read more...} */ readonly hasZ: boolean; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#fields field} containing a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#objectIdField Read more...} */ readonly objectIdField: string; /** * The rendering order of features in the view based on the CatalogLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#orderBy orderBy} property. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#orderBy Read more...} */ readonly orderBy: OrderByInfo[] | nullish; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#outFields Read more...} */ readonly outFields: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#preferredTimeZone Read more...} */ readonly preferredTimeZone: string | nullish; /** * When `true`, indicates that m-values will be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#returnM Read more...} */ readonly returnM: boolean | nullish; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#returnZ Read more...} */ readonly returnZ: boolean | nullish; /** * The spatial reference the source data is stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#timeExtent Read more...} */ readonly timeExtent: TimeExtent | nullish; /** * TimeInfo provides information such as date fields that store {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time for each feature and the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#timeInfo Read more...} */ readonly timeInfo: TimeInfo | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#timeOffset Read more...} */ readonly timeOffset: TimeInterval | nullish; readonly type: "catalog-footprint"; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#useViewTime Read more...} */ readonly useViewTime: boolean; /** * CatalogFootprintLayer is a layer that represents the footprints of items referenced in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html catalog layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html Read more...} */ constructor(properties?: CatalogFootprintLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#elevationInfo Read more...} */ get elevationInfo(): CatalogFootprintLayerElevationInfo | nullish; set elevationInfo(value: CatalogFootprintLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#definitionExpression definitionExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: CatalogFootprintLayerGetFieldDomainOptions): Domain | nullish; /** * Executes an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a CatalogFootprintLayer, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: CatalogFootprintLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: CatalogFootprintLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: CatalogFootprintLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: CatalogFootprintLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns an array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: CatalogFootprintLayerQueryObjectIdsOptions): Promise<(number | string)[]>; } interface CatalogFootprintLayerProperties extends LayerProperties, BlendLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Array of Chart Items of type WebMapWebChart available on the footprint layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#charts Read more...} */ charts?: any[] | nullish; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#elevationInfo Read more...} */ elevationInfo?: CatalogFootprintLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; } export interface CatalogFootprintLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: CatalogFootprintLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface CatalogFootprintLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): CatalogFootprintLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: CatalogFootprintLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface CatalogFootprintLayerElevationInfoFeatureExpressionInfoProperties { expression?: string; } export interface CatalogFootprintLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { expression: string; } export interface CatalogFootprintLayerGetFieldDomainOptions { feature: Graphic; } export interface CatalogFootprintLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface CatalogFootprintLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface CatalogFootprintLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface CatalogFootprintLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface CatalogFootprintLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } /** * Provides utility functions for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-catalogUtils.html Read more...} */ interface catalogUtils { /** * Utility method to get the parent {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} for a given layer in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html#layers CatalogDynamicGroupLayer.layers} collection. * * @param layer The layer for which the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} is to be retrieved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-catalogUtils.html#getCatalogLayerForLayer Read more...} */ getCatalogLayerForLayer(layer: Layer): CatalogLayer | nullish; /** * Utility method to check if the layer is temporarily available in the map and can be removed at any time because it is part of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer}. * * @param layer The layer to test. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-catalogUtils.html#isLayerFromCatalog Read more...} */ isLayerFromCatalog(layer: Layer): boolean; } export const catalogUtils: catalogUtils; export interface CatalogLayer extends Layer, APIKeyMixin, BlendLayer, DisplayFilteredLayer, FeatureLayerBase, CustomParametersMixin, OperationalLayer, OrderedLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, TemporalLayer { } export class CatalogLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#capabilities Read more...} */ declare readonly capabilities: FeatureLayerBase["capabilities"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#copyright Read more...} */ declare copyright: FeatureLayerBase["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dateFieldsTimeZone Read more...} */ declare dateFieldsTimeZone: FeatureLayerBase["dateFieldsTimeZone"]; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#datesInUnknownTimezone Read more...} */ declare readonly datesInUnknownTimezone: FeatureLayerBase["datesInUnknownTimezone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#definitionExpression Read more...} */ declare definitionExpression: FeatureLayerBase["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayField Read more...} */ declare displayField: FeatureLayerBase["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * The draw order field holds the value to sort catalog items (layers). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#drawOrderField Read more...} */ readonly drawOrderField: "cd_draworder"; /** * The dynamicGroupLayer includes the catalog items (layers) that are currently visible in your view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer Read more...} */ readonly dynamicGroupLayer: CatalogDynamicGroupLayer; /** * The editor tracking fields, which record who adds or edits the data through the feature service * and when edits are made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#editFieldsInfo Read more...} */ declare readonly editFieldsInfo: FeatureLayerBase["editFieldsInfo"]; /** * Specifies information about editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#editingInfo Read more...} */ declare readonly editingInfo: FeatureLayerBase["editingInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#effectiveCapabilities Read more...} */ declare readonly effectiveCapabilities: FeatureLayerBase["effectiveCapabilities"]; /** * Indicates whether the layer is editable taking in to consideration privileges of the * currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#effectiveEditingEnabled Read more...} */ declare readonly effectiveEditingEnabled: FeatureLayerBase["effectiveEditingEnabled"]; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fields Read more...} */ readonly fields: Field[] | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fieldsIndex Read more...} */ declare readonly fieldsIndex: FeatureLayerBase["fieldsIndex"]; /** * The footprint layer is a layer that displays footprints of items referenced in a CatalogLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#footprintLayer Read more...} */ readonly footprintLayer: CatalogFootprintLayer; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#gdbVersion Read more...} */ declare gdbVersion: FeatureLayerBase["gdbVersion"]; /** * Provides information on the system maintained area and length fields along with their respective units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#geometryFieldsInfo Read more...} */ declare readonly geometryFieldsInfo: FeatureLayerBase["geometryFieldsInfo"]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#geometryType Read more...} */ readonly geometryType: "polygon"; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#globalIdField Read more...} */ declare globalIdField: FeatureLayerBase["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#hasM Read more...} */ declare hasM: FeatureLayerBase["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#hasZ Read more...} */ declare hasZ: FeatureLayerBase["hasZ"]; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#isTable Read more...} */ declare readonly isTable: FeatureLayerBase["isTable"]; /** * The item name field stores the name of the catalog item referenced in the CatalogLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#itemNameField Read more...} */ readonly itemNameField: "cd_itemname"; /** * The item source field stores the original source path of the catalog item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#itemSourceField Read more...} */ readonly itemSourceField: "cd_itemsource"; /** * The item type field stores the type of the catalog item, such as `Feature Service` or `Map Service`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#itemTypeField Read more...} */ readonly itemTypeField: "cd_itemtype"; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#layerId Read more...} */ declare layerId: FeatureLayerBase["layerId"]; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogDynamicGroupLayer.html CatalogDynamicGroupLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#layers Read more...} */ readonly layers: Collection; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The max scale field holds the maximum scale at which the catalog item is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#maxScaleField Read more...} */ readonly maxScaleField: "cd_maxscale"; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The min scale field holds the minimum scale at which the catalog item is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#minScaleField Read more...} */ readonly minScaleField: "cd_minscale"; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#objectIdField Read more...} */ declare objectIdField: FeatureLayerBase["objectIdField"]; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#preferredTimeZone Read more...} */ declare readonly preferredTimeZone: FeatureLayerBase["preferredTimeZone"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} set up for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#relationships Read more...} */ declare readonly relationships: FeatureLayerBase["relationships"]; /** * When `true`, indicates that M values will be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#returnM Read more...} */ declare returnM: FeatureLayerBase["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#returnZ Read more...} */ declare returnZ: FeatureLayerBase["returnZ"]; /** * The service definition expression limits the features available for display and query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#serviceDefinitionExpression Read more...} */ declare readonly serviceDefinitionExpression: FeatureLayerBase["serviceDefinitionExpression"]; /** * Indicates the portal item of the hosted feature service that contains this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#serviceItemId Read more...} */ declare readonly serviceItemId: FeatureLayerBase["serviceItemId"]; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#sourceJSON Read more...} */ declare sourceJSON: FeatureLayerBase["sourceJSON"]; /** * The name of the field which holds the id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#subtypes subtypes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#subtypeField Read more...} */ declare readonly subtypeField: FeatureLayerBase["subtypeField"]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html subtypes} defined in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#subtypes Read more...} */ declare readonly subtypes: FeatureLayerBase["subtypes"]; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#title Read more...} */ declare title: FeatureLayerBase["title"]; readonly type: "catalog"; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#url Read more...} */ declare url: FeatureLayerBase["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The version of GeoScene Server in which the layer is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#version Read more...} */ declare readonly version: FeatureLayerBase["version"]; /** * CatalogLayer points to different portal items and services, helping you to better organize and manage your data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html Read more...} */ constructor(properties?: CatalogLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#elevationInfo Read more...} */ get elevationInfo(): FeatureLayerBaseElevationInfo | nullish; set elevationInfo(value: FeatureLayerBaseElevationInfoProperties | nullish); /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#floorInfo Read more...} */ get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Returns a footprint {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphic} that represents a layer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamicGroupLayer}. * * @param layer A layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamicGroupLayer} for which to obtain its footprint from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#createFootprintFromLayer Read more...} */ createFootprintFromLayer(layer: Layer): Graphic | nullish; /** * Creates a new instance of a layer for the given layer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamicGroupLayer} based on its footprint feature. * * @param footprint The footprint feature used to instantiate a layer within its bounds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#createLayerFromFootprint Read more...} */ createLayerFromFootprint(footprint: Graphic): Promise; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#definitionExpression definitionExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: FeatureLayerBaseGetFieldDomainOptions): Domain | nullish; /** * Executes an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a CatalogLayer, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: CatalogLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: CatalogLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: CatalogLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: CatalogLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns an array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: CatalogLayerQueryObjectIdsOptions): Promise<(number | string)[]>; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#refresh Read more...} */ refresh(): void; on(name: "refresh", eventHandler: CatalogLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: CatalogLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: CatalogLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: CatalogLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): CatalogLayer; } interface CatalogLayerProperties extends LayerProperties, APIKeyMixinProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureLayerBaseProperties, CustomParametersMixinProperties, OperationalLayerProperties, OrderedLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#copyright Read more...} */ copyright?: FeatureLayerBaseProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dateFieldsTimeZone Read more...} */ dateFieldsTimeZone?: FeatureLayerBaseProperties["dateFieldsTimeZone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#definitionExpression Read more...} */ definitionExpression?: FeatureLayerBaseProperties["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayField Read more...} */ displayField?: FeatureLayerBaseProperties["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#elevationInfo Read more...} */ elevationInfo?: FeatureLayerBaseElevationInfoProperties | nullish; /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#floorInfo Read more...} */ floorInfo?: LayerFloorInfoProperties | nullish; /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#gdbVersion Read more...} */ gdbVersion?: FeatureLayerBaseProperties["gdbVersion"]; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#globalIdField Read more...} */ globalIdField?: FeatureLayerBaseProperties["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#hasM Read more...} */ hasM?: FeatureLayerBaseProperties["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#hasZ Read more...} */ hasZ?: FeatureLayerBaseProperties["hasZ"]; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#layerId Read more...} */ layerId?: FeatureLayerBaseProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#objectIdField Read more...} */ objectIdField?: FeatureLayerBaseProperties["objectIdField"]; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * When `true`, indicates that M values will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#returnM Read more...} */ returnM?: FeatureLayerBaseProperties["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#returnZ Read more...} */ returnZ?: FeatureLayerBaseProperties["returnZ"]; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#sourceJSON Read more...} */ sourceJSON?: FeatureLayerBaseProperties["sourceJSON"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#title Read more...} */ title?: FeatureLayerBaseProperties["title"]; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#url Read more...} */ url?: FeatureLayerBaseProperties["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } export interface CatalogLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface CatalogLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface CatalogLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface CatalogLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface CatalogLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface CatalogLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface CatalogLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface CatalogLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface CatalogLayerRefreshEvent { dataChanged: boolean; } export interface CSVLayer extends Layer, BlendLayer, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OrderedLayer, ScaleRangeLayer, TemporalLayer, TrackableLayer { } export class CSVLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#customParameters Read more...} */ customParameters: any; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#dateFieldsTimeZone Read more...} */ readonly dateFieldsTimeZone: string | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * The column delimiter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#delimiter Read more...} */ delimiter: string; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the CSVLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#geometryType Read more...} */ geometryType: "point"; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#isTable Read more...} */ readonly isTable: boolean; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * The latitude field name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#latitudeField Read more...} */ latitudeField: string | nullish; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The longitude field name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#longitudeField Read more...} */ longitudeField: string | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#objectIdField Read more...} */ objectIdField: string; /** * An array of field names to include in the CSVLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#refreshInterval Read more...} */ refreshInterval: number; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; readonly type: "csv"; /** * The URL of the CSV file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#url Read more...} */ url: string | nullish; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The CSVLayer is a point layer based on a CSV file (.csv, .txt). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html Read more...} */ constructor(properties?: CSVLayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#elevationInfo Read more...} */ get elevationInfo(): CSVLayerElevationInfo | nullish; set elevationInfo(value: CSVLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item referencing the CSV file from which the CSVLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameters that can be used to fetch features that * satisfy the layer's current filters, and definitions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: CSVLayerGetFieldDomainOptions): Domain | nullish; /** * Executes an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a CSVLayer, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: CSVLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the CSV data and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: CSVLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the CSV data and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: CSVLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the CSV data and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: CSVLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the CSV data and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: CSVLayerQueryObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#refresh Read more...} */ 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; } interface CSVLayerProperties extends LayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, TrackableLayerProperties { /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#customParameters Read more...} */ customParameters?: any; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * The column delimiter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#delimiter Read more...} */ delimiter?: string; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#elevationInfo Read more...} */ elevationInfo?: CSVLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the CSVLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#geometryType Read more...} */ geometryType?: "point"; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The latitude field name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#latitudeField Read more...} */ latitudeField?: string | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The longitude field name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#longitudeField Read more...} */ longitudeField?: string | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names to include in the CSVLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item referencing the CSV file from which the CSVLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#refreshInterval Read more...} */ refreshInterval?: number; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The URL of the CSV file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#url Read more...} */ url?: string | nullish; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } export interface CSVLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: CSVLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface CSVLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): CSVLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: CSVLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface CSVLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface CSVLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface CSVLayerGetFieldDomainOptions { feature: Graphic; } export interface CSVLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface CSVLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface CSVLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface CSVLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface CSVLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } 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 { /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html DimensionAnalysis} associated with the layer that stores the dimension shapes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#source Read more...} */ source: DimensionAnalysis; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; readonly type: "dimension"; /** * The dimension layer displays measurement annotations of lengths and distances in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html Read more...} */ constructor(properties?: DimensionLayerProperties); /** * The style defines how the dimension objects of this layer are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#style Read more...} */ get style(): DimensionSimpleStyle; set style(value: DimensionSimpleStyleProperties & { type: "simple" }); static fromJSON(json: any): DimensionLayer; } interface DimensionLayerProperties extends LayerProperties, OperationalLayerProperties { /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html DimensionAnalysis} associated with the layer that stores the dimension shapes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#source Read more...} */ source?: DimensionAnalysis; /** * The style defines how the dimension objects of this layer are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#style Read more...} */ style?: DimensionSimpleStyleProperties & { type: "simple" }; } export interface ElevationLayer extends Layer, GeoSceneCachedService, PortalLayer, OperationalLayer { } export class ElevationLayer { /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#copyright Read more...} */ declare copyright: GeoSceneCachedService["copyright"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The [image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#sourceJSON Read more...} */ sourceJSON: any; /** * The spatial reference of the layer as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#spatialReference Read more...} */ declare readonly spatialReference: GeoSceneCachedService["spatialReference"]; readonly type: "elevation"; /** * URL pointing to the Elevation layer resource on an GeoScene Image Server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#url Read more...} */ url: string | nullish; /** * ElevationLayer is a tile layer used for rendering elevations in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneViews}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html Read more...} */ constructor(properties?: ElevationLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * Contains information about the tiling scheme for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); /** * Creates an elevation sampler for the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} by querying the service layer * for elevation data and caching it so values may be sampled quickly afterwards. * * @param extent The extent for which to create the sampler. * @param options Additional query options. See the table below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#createElevationSampler Read more...} */ createElevationSampler(extent: Extent, options?: ElevationLayerCreateElevationSamplerOptions): Promise; /** * Requests a tile from the service and decodes the data into a linear * array of elevation values. * * @param level the tile level. * @param row the tile row. * @param column the tile column. * @param options Optional settings for the tile request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#fetchTile Read more...} */ 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. * * @param level The requested tile's level. * @param row The requested tile's row. * @param col The requested tile's column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#getTileUrl Read more...} */ getTileUrl(level: number, row: number, col: number): string; /** * Queries the service layer for elevation values for the given geometry. * * @param geometry The geometry to use for sampling elevation data. * @param options Additional query options. See the table below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#queryElevation Read more...} */ queryElevation(geometry: Point | Multipoint | Polyline, options?: ElevationLayerQueryElevationOptions): Promise; static fromJSON(json: any): ElevationLayer; } interface ElevationLayerProperties extends LayerProperties, GeoSceneCachedServiceProperties, PortalLayerProperties, OperationalLayerProperties { /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#copyright Read more...} */ copyright?: GeoSceneCachedServiceProperties["copyright"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The [image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#sourceJSON Read more...} */ sourceJSON?: any; /** * Contains information about the tiling scheme for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties; /** * URL pointing to the Elevation layer resource on an GeoScene Image Server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#url Read more...} */ url?: string | nullish; } export interface ElevationLayerCreateElevationSamplerOptions { demResolution?: number | string; noDataValue?: number; signal?: AbortSignal | nullish; } export interface ElevationLayerFetchTileOptions { noDataValue?: number; signal?: AbortSignal | nullish; } export interface ElevationLayerQueryElevationOptions { demResolution?: number | string; returnSampleInfo?: boolean; noDataValue?: number; signal?: AbortSignal | nullish; } /** * Object returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#queryElevation queryElevation()} promise resolves:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html#ElevationQueryResult Read more...} */ export interface ElevationLayerElevationQueryResult { geometry: Point | Multipoint | Polyline; sampleInfo?: ElevationLayerElevationQueryResultSampleInfo[]; noDataValue: number | nullish; } export interface ElevationLayerElevationQueryResultSampleInfo { demResolution: number; } export interface FeatureLayer extends Layer, APIKeyMixin, BlendLayer, Clonable, CustomParametersMixin, DisplayFilteredLayer, FeatureEffectLayer, FeatureLayerBase, FeatureReductionLayer, OperationalLayer, OrderedLayer, PortalLayer, PublishableLayer, ScaleRangeLayer, TemporalLayer, TrackableLayer { } export class FeatureLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#capabilities Read more...} */ declare readonly capabilities: FeatureLayerBase["capabilities"]; /** * Array of Chart Items of type WebMapWebChart available on the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#charts Read more...} */ charts: any[] | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#copyright Read more...} */ declare copyright: FeatureLayerBase["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#dateFieldsTimeZone Read more...} */ declare dateFieldsTimeZone: FeatureLayerBase["dateFieldsTimeZone"]; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#datesInUnknownTimezone Read more...} */ declare readonly datesInUnknownTimezone: FeatureLayerBase["datesInUnknownTimezone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression Read more...} */ declare definitionExpression: FeatureLayerBase["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayField Read more...} */ declare displayField: FeatureLayerBase["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * An object that allows you to create a dynamic layer with data * either from map service sublayers or data from a registered workspace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#dynamicDataSource Read more...} */ dynamicDataSource: DynamicDataLayer | nullish; /** * The editor tracking fields, which record who adds or edits the data through the feature service * and when edits are made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#editFieldsInfo Read more...} */ declare readonly editFieldsInfo: FeatureLayerBase["editFieldsInfo"]; /** * Determines if the layer is editable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#editingEnabled Read more...} */ editingEnabled: boolean; /** * Specifies information about editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#editingInfo Read more...} */ declare readonly editingInfo: FeatureLayerBase["editingInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#effectiveCapabilities Read more...} */ declare readonly effectiveCapabilities: FeatureLayerBase["effectiveCapabilities"]; /** * Indicates whether the layer is editable taking in to consideration privileges of the * currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#effectiveEditingEnabled Read more...} */ declare readonly effectiveEditingEnabled: FeatureLayerBase["effectiveEditingEnabled"]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fieldsIndex Read more...} */ declare readonly fieldsIndex: FeatureLayerBase["fieldsIndex"]; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#gdbVersion Read more...} */ declare gdbVersion: FeatureLayerBase["gdbVersion"]; /** * Provides information on the system maintained area and length fields along with their respective units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#geometryFieldsInfo Read more...} */ declare readonly geometryFieldsInfo: FeatureLayerBase["geometryFieldsInfo"]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#geometryType Read more...} */ declare geometryType: FeatureLayerBase["geometryType"]; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#globalIdField Read more...} */ declare globalIdField: FeatureLayerBase["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#hasM Read more...} */ declare hasM: FeatureLayerBase["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#hasZ Read more...} */ declare hasZ: FeatureLayerBase["hasZ"]; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#isTable Read more...} */ declare readonly isTable: FeatureLayerBase["isTable"]; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#layerId Read more...} */ declare layerId: FeatureLayerBase["layerId"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#objectIdField Read more...} */ declare objectIdField: FeatureLayerBase["objectIdField"]; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#preferredTimeZone Read more...} */ declare readonly preferredTimeZone: FeatureLayerBase["preferredTimeZone"]; /** * Checks layer's publishing status while the layer is being published to the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#publishingInfo Read more...} */ declare readonly publishingInfo: PublishableLayer["publishingInfo"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#refreshInterval Read more...} */ refreshInterval: number; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} set up for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#relationships Read more...} */ declare readonly relationships: FeatureLayerBase["relationships"]; /** * When `true`, indicates that M values will be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#returnM Read more...} */ declare returnM: FeatureLayerBase["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#returnZ Read more...} */ declare returnZ: FeatureLayerBase["returnZ"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; /** * The service definition expression limits the features available for display and query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#serviceDefinitionExpression Read more...} */ declare readonly serviceDefinitionExpression: FeatureLayerBase["serviceDefinitionExpression"]; /** * Indicates the portal item of the hosted feature service that contains this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#serviceItemId Read more...} */ declare readonly serviceItemId: FeatureLayerBase["serviceItemId"]; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#sourceJSON Read more...} */ declare sourceJSON: FeatureLayerBase["sourceJSON"]; /** * The name of the field which holds the id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#subtypes subtypes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#subtypeField Read more...} */ declare readonly subtypeField: FeatureLayerBase["subtypeField"]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html subtypes} defined in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#subtypes Read more...} */ declare readonly subtypes: FeatureLayerBase["subtypes"]; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#title Read more...} */ declare title: FeatureLayerBase["title"]; readonly type: "feature"; /** * The name of the field holding the type ID for the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#typeIdField Read more...} */ typeIdField: string | nullish; /** * This property contains an array of field names that are used to uniquely identify a feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#uniqueIdFields Read more...} */ readonly uniqueIdFields: string[] | nullish; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#url Read more...} */ declare url: FeatureLayerBase["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The version of GeoScene Server in which the layer is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#version Read more...} */ declare readonly version: FeatureLayerBase["version"]; /** * A FeatureLayer is a single layer that can be created from a * [Map Service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-map-service.htm) * or [Feature Service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-feature-service-.htm); * GeoScene Online or GeoScene Enterprise portal items; or from an array of client-side features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html Read more...} */ constructor(properties?: FeatureLayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#elevationInfo Read more...} */ get elevationInfo(): FeatureLayerBaseElevationInfo | nullish; set elevationInfo(value: FeatureLayerBaseElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#floorInfo Read more...} */ get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used in an associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#formTemplate Read more...} */ get formTemplate(): FormTemplate | nullish; set formTemplate(value: FormTemplateProperties | nullish); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} objects used to create a FeatureLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#source Read more...} */ get source(): Collection; set source(value: CollectionProperties); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * An array of feature templates defined in the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#templates Read more...} */ get templates(): FeatureTemplate[] | nullish; set templates(value: FeatureTemplateProperties[] | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html types} defined in the feature service exposed by GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#types Read more...} */ get types(): FeatureType[] | nullish; set types(value: FeatureTypeProperties[] | nullish); /** * Adds an attachment to a feature. * * @param feature Feature to which the attachment is to be added. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#addAttachment Read more...} */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): Promise; /** * Applies edits to features in a layer. * * @param edits Object containing features and attachments to be added, updated or deleted. * @param options Additional edit options to specify when editing features or attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#applyEdits Read more...} */ applyEdits(edits: FeatureLayerApplyEditsEdits, options?: FeatureLayerApplyEditsOptions): Promise; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#clone Read more...} */ clone(): this; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameter object that can be used to fetch features that * satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression definitionExpression}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#gdbVersion gdbVersion}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#historicMoment historicMoment}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Deletes attachments from a feature. * * @param feature Feature containing attachments to be deleted. * @param attachmentIds Ids of the attachments to be deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#deleteAttachments Read more...} */ deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html FeatureType} describing the feature's type. * * @param feature A feature from this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#getFeatureType Read more...} */ getFeatureType(feature: Graphic | nullish): FeatureType | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: FeatureLayerBaseGetFieldDomainOptions): Domain | nullish; /** * Query information about attachments associated with features. * * @param attachmentQuery Specifies the attachment parameters for query. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryAttachments Read more...} */ queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: FeatureLayerQueryAttachmentsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a feature service, which groups features into bins based on ranges in numeric or date fields, and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: FeatureLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: FeatureLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: FeatureLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: FeatureLayerQueryObjectIdsOptions): Promise<(number | string)[]>; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSets} grouped by source layer or table objectIds. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryRelatedFeatures Read more...} */ queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: FeatureLayerQueryRelatedFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * when resolved, it returns an `object` containing key value pairs. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryRelatedFeaturesCount Read more...} */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: FeatureLayerQueryRelatedFeaturesCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns * the count of features or records that satisfy the query. * * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryTopFeatureCount Read more...} */ queryTopFeatureCount(topFeaturesQuery: TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryTopFeatures Read more...} */ queryTopFeatures(topFeaturesQuery: TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryTopFeaturesExtent Read more...} */ queryTopFeaturesExtent(topFeaturesQuery: TopFeaturesQueryProperties, options?: FeatureLayerQueryTopFeaturesExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns an * array of Object IDs of features that satisfy the query. * * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryTopObjectIds Read more...} */ queryTopObjectIds(topFeaturesQuery: TopFeaturesQueryProperties, options?: FeatureLayerQueryTopObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#refresh Read more...} */ refresh(): void; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#save Read more...} */ save(options?: FeatureLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: FeatureLayerSaveAsOptions): Promise; /** * Updates an existing attachment for a feature. * * @param feature The feature containing the attachment to be updated. * @param attachmentId Id of the attachment to be updated. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#updateAttachment Read more...} */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise; 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, APIKeyMixinProperties, BlendLayerProperties, CustomParametersMixinProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureLayerBaseProperties, FeatureReductionLayerProperties, OperationalLayerProperties, OrderedLayerProperties, PortalLayerProperties, PublishableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, TrackableLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Array of Chart Items of type WebMapWebChart available on the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#charts Read more...} */ charts?: any[] | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#copyright Read more...} */ copyright?: FeatureLayerBaseProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#dateFieldsTimeZone Read more...} */ dateFieldsTimeZone?: FeatureLayerBaseProperties["dateFieldsTimeZone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression Read more...} */ definitionExpression?: FeatureLayerBaseProperties["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayField Read more...} */ displayField?: FeatureLayerBaseProperties["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * An object that allows you to create a dynamic layer with data * either from map service sublayers or data from a registered workspace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#dynamicDataSource Read more...} */ dynamicDataSource?: DynamicDataLayer | nullish; /** * Determines if the layer is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#editingEnabled Read more...} */ editingEnabled?: boolean; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#elevationInfo Read more...} */ elevationInfo?: FeatureLayerBaseElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#floorInfo Read more...} */ floorInfo?: LayerFloorInfoProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used in an associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#formTemplate Read more...} */ formTemplate?: FormTemplateProperties | nullish; /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#gdbVersion Read more...} */ gdbVersion?: FeatureLayerBaseProperties["gdbVersion"]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#geometryType Read more...} */ geometryType?: FeatureLayerBaseProperties["geometryType"]; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#globalIdField Read more...} */ globalIdField?: FeatureLayerBaseProperties["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#hasM Read more...} */ hasM?: FeatureLayerBaseProperties["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#hasZ Read more...} */ hasZ?: FeatureLayerBaseProperties["hasZ"]; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#layerId Read more...} */ layerId?: FeatureLayerBaseProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#objectIdField Read more...} */ objectIdField?: FeatureLayerBaseProperties["objectIdField"]; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#refreshInterval Read more...} */ refreshInterval?: number; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * When `true`, indicates that M values will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#returnM Read more...} */ returnM?: FeatureLayerBaseProperties["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#returnZ Read more...} */ returnZ?: FeatureLayerBaseProperties["returnZ"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} objects used to create a FeatureLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#source Read more...} */ source?: CollectionProperties; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#sourceJSON Read more...} */ sourceJSON?: FeatureLayerBaseProperties["sourceJSON"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * An array of feature templates defined in the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#templates Read more...} */ templates?: FeatureTemplateProperties[] | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#title Read more...} */ title?: FeatureLayerBaseProperties["title"]; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The name of the field holding the type ID for the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#typeIdField Read more...} */ typeIdField?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html types} defined in the feature service exposed by GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#types Read more...} */ types?: FeatureTypeProperties[] | nullish; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#url Read more...} */ url?: FeatureLayerBaseProperties["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } /** * AttachmentEdit represents an attachment that can be added, updated or deleted via {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#applyEdits applyEdits}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#AttachmentEdit Read more...} */ export interface AttachmentEdit { feature: Graphic | FeatureIdentifier; attachment: AttachmentEditAttachment; } /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#Capabilities Read more...} */ export interface Capabilities { analytics: CapabilitiesAnalytics; attachment: CapabilitiesAttachment | nullish; data: CapabilitiesData; editing: CapabilitiesEditing; metadata: CapabilitiesMetadata; operations: CapabilitiesOperations; query: CapabilitiesQuery; queryAttributeBins: CapabilitiesQueryAttributeBins; queryRelated: CapabilitiesQueryRelated; queryTopFeatures: CapabilitiesQueryTopFeatures; } /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#applyEdits applyEdits} method if the `returnServiceEditsOption` parameter is set to `original-and-current-features`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#EditedFeatureResult Read more...} */ export interface EditedFeatureResult { layerId: number; editedFeatures: EditedFeatureResultEditedFeatures; } /** * The fields that record who adds or edits data in the feature service and when the edit is made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#EditFieldsInfo Read more...} */ export interface EditFieldsInfo { creatorField: string; creationDateField: string; editorField: string; editDateField: string; } /** * Specifies information about editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#EditingInfo Read more...} */ export interface EditingInfo { lastEditDate: Date | nullish; } export interface FeatureLayerEditsEvent { addedAttachments: FeatureEditResult[]; addedFeatures: FeatureEditResult[]; deletedAttachments: FeatureEditResult[]; deletedFeatures: FeatureEditResult[]; editedFeatures: EditedFeatureResult; exceededTransferLimit: boolean; updatedAttachments: FeatureEditResult[]; updatedFeatures: FeatureEditResult[]; } /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#applyEdits applyEdits} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#EditsResult Read more...} */ export interface EditsResult { addFeatureResults: FeatureEditResult[]; updateFeatureResults: FeatureEditResult[]; deleteFeatureResults: FeatureEditResult[]; addAttachmentResults: FeatureEditResult[]; updateAttachmentResults: FeatureEditResult[]; deleteAttachmentResults: FeatureEditResult[]; editedFeatureResults?: EditedFeatureResult[]; editMoment?: number; } /** * FeatureEditResult represents the result of adding, updating or deleting a feature or an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#FeatureEditResult Read more...} */ export interface FeatureEditResult { objectId?: number | nullish; globalId?: string | nullish; error?: FeatureEditResultError | nullish; } /** * A feature identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#FeatureIdentifier Read more...} */ export interface FeatureIdentifier { objectId?: number | nullish; globalId?: string | nullish; } export interface FeatureLayerApplyEditsEdits { addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | FeatureIdentifier[]; addAttachments?: AttachmentEdit[]; updateAttachments?: AttachmentEdit[]; deleteAttachments?: string[]; } export interface FeatureLayerApplyEditsOptions { gdbVersion?: string; returnEditMoment?: boolean; returnServiceEditsOption?: "none" | "original-and-current-features"; rollbackOnFailureEnabled?: boolean; globalIdUsed?: boolean; } export interface FeatureLayerQueryAttachmentsOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryRelatedFeaturesCountOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryRelatedFeaturesOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryTopFeatureCountOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryTopFeaturesExtentOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryTopFeaturesOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerQueryTopObjectIdsOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface FeatureLayerSaveOptions { ignoreUnsupported?: boolean; } 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 { globalId: string; name?: string; contentType?: string; uploadId?: string; data?: Blob | File | string; } export interface CapabilitiesAnalytics { supportsCacheHint: boolean; } export interface CapabilitiesAttachment { supportsCacheHint: boolean; supportsContentType: boolean; supportsExifInfo: boolean; supportsKeywords: boolean; supportsOrderByFields: boolean; supportsName: boolean; supportsSize: boolean; supportsResize: boolean; } export interface CapabilitiesData { isVersioned: boolean; isBranchVersioned: boolean; supportsAttachment: boolean; supportsM: boolean; supportsZ: boolean; } export interface CapabilitiesEditing { supportsDeleteByAnonymous: boolean; supportsDeleteByOthers: boolean; supportsGeometryUpdate: boolean; supportsGlobalId: boolean; supportsRollbackOnFailure: boolean; supportsUpdateByAnonymous: boolean; supportsUpdateByOthers: boolean; supportsUploadWithItemId: boolean; supportsUpdateWithoutM: boolean; } export interface CapabilitiesMetadata { supportsAdvancedFieldProperties: boolean; } export interface CapabilitiesOperations { supportsAdd: boolean; supportsCalculate: boolean; supportsDelete: boolean; supportsEditing: boolean; supportsQuery: boolean; supportsQueryAttachments: boolean; supportsResizeAttachments: boolean; supportsQueryTopFeatures: boolean; supportsUpdate: boolean; supportsValidateSql: boolean; } export interface CapabilitiesQuery { maxRecordCount: number | nullish; maxUniqueIDCount: number | nullish; supportsCacheHint: boolean; supportsCentroid: boolean; supportsDisjointSpatialRelationship: boolean; supportsDistance: boolean; supportsDistinct: boolean; supportsExtent: boolean; supportsGeometryProperties: boolean; supportsHavingClause: boolean; supportsHistoricMoment: boolean; supportsMaxRecordCountFactor: boolean; supportsOrderBy: boolean; supportsPagination: boolean; supportsPercentileStatistics: boolean; supportsQuantization: boolean; supportsQuantizationEditMode: boolean; supportsQueryGeometry: boolean; supportsResultType: boolean; supportsReturnMesh: boolean; supportsStandardizedQueriesOnly: boolean; supportsStatistics: boolean; supportsSqlExpression: boolean; supportsSpatialAggregationStatistics: boolean; supportsTrueCurve: boolean; supportedSpatialAggregationStatistics: CapabilitiesQuerySupportedSpatialAggregationStatistics; } export interface CapabilitiesQueryAttributeBins { supportsDate: boolean; supportsFixedInterval: boolean; supportsAutoInterval: boolean; supportsFixedBoundaries: boolean; supportsStackBy: boolean; supportsSplitBy: boolean; supportsSnapToData: boolean; supportsReturnFullIntervalBin: boolean; supportsFirstDayOfWeek: boolean; supportsNormalization: boolean; supportedNormalizationTypes?: CapabilitiesQueryAttributeBinsSupportedNormalizationTypes | nullish; supportedStatistics?: CapabilitiesQueryAttributeBinsSupportedStatistics | nullish; } export interface CapabilitiesQueryAttributeBinsSupportedNormalizationTypes { field?: boolean; log?: boolean; naturalLog?: boolean; percentOfTotal?: boolean; squareRoot?: boolean; } export interface CapabilitiesQueryAttributeBinsSupportedStatistics { count?: boolean; sum?: boolean; avg?: boolean; var?: boolean; stddev?: boolean; min?: boolean; max?: boolean; percentileContinuous?: boolean; percentileDiscrete?: boolean; } export interface CapabilitiesQueryRelated { supportsCacheHint: boolean; supportsCount: boolean; supportsOrderBy: boolean; supportsPagination: boolean; } export interface CapabilitiesQuerySupportedSpatialAggregationStatistics { centroid: boolean; envelope: boolean; convexHull: boolean; } export interface CapabilitiesQueryTopFeatures { supportsCacheHint: boolean; } export interface EditedFeatureResultEditedFeatures { adds: Graphic[]; updates: EditedFeatureResultEditedFeaturesUpdates[]; deletes: Graphic[]; spatialReference: SpatialReference | nullish; } export interface EditedFeatureResultEditedFeaturesUpdates { original: Graphic; current: Graphic; } export interface FeatureEditResultError { name: string; message: string; } export interface GeoJSONLayer extends Layer, BlendLayer, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, OrderedLayer, ScaleRangeLayer, TrackableLayer { } export class GeoJSONLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#customParameters Read more...} */ customParameters: any; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#dateFieldsTimeZone Read more...} */ readonly dateFieldsTimeZone: string | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * Indicates if the layer is editable. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#editingEnabled Read more...} */ editingEnabled: boolean; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#geometryType Read more...} */ geometryType: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#hasZ Read more...} */ readonly hasZ: boolean; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#isTable Read more...} */ readonly isTable: boolean; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#fields field} containing a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#objectIdField Read more...} */ objectIdField: string; /** * An array of field names from the geoJSON file to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#refreshInterval Read more...} */ refreshInterval: number; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; readonly type: "geojson"; /** * The URL of the GeoJSON file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#url Read more...} */ url: string | nullish; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#useViewTime Read more...} */ useViewTime: boolean; /** * The GeoJSONLayer class is used to create a layer based on [GeoJSON](http://geojson.org/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html Read more...} */ constructor(properties?: GeoJSONLayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#elevationInfo Read more...} */ get elevationInfo(): GeoJSONLayerElevationInfo | nullish; set elevationInfo(value: GeoJSONLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item referencing the geojson file from which the GeoJSONLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * An array of feature templates defined in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#templates Read more...} */ get templates(): FeatureTemplate[] | nullish; set templates(value: FeatureTemplateProperties[] | nullish); /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * Applies edits to features in a layer. * * @param edits Object containing features to be added, updated or deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#applyEdits Read more...} */ applyEdits(edits: GeoJSONLayerApplyEditsEdits): Promise; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameter object that can be used to fetch features that * satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#definitionExpression definitionExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the Domain associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: GeoJSONLayerGetFieldDomainOptions): Domain | nullish; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a GeoJSONLayer, which groups features into bins based on ranges in numeric or date fields, and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: GeoJSONLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: GeoJSONLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: GeoJSONLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: GeoJSONLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: GeoJSONLayerQueryObjectIdsOptions): Promise<(number | string)[]>; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#refresh Read more...} */ 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, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, TrackableLayerProperties { /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#customParameters Read more...} */ customParameters?: any; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Indicates if the layer is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#editingEnabled Read more...} */ editingEnabled?: boolean; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#elevationInfo Read more...} */ elevationInfo?: GeoJSONLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#geometryType Read more...} */ geometryType?: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#fields field} containing a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names from the geoJSON file to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item referencing the geojson file from which the GeoJSONLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#refreshInterval Read more...} */ refreshInterval?: number; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * An array of feature templates defined in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#templates Read more...} */ templates?: FeatureTemplateProperties[] | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The URL of the GeoJSON file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#url Read more...} */ url?: string | nullish; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html#useViewTime Read more...} */ useViewTime?: boolean; } export interface GeoJSONLayerEditsEvent { addedFeatures: GeoJSONLayerEditsEventAddedFeatures[]; deletedFeatures: GeoJSONLayerEditsEventDeletedFeatures[]; updatedFeatures: GeoJSONLayerEditsEventUpdatedFeatures[]; } export interface GeoJSONLayerApplyEditsEdits { addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | any[] | Collection; } export interface GeoJSONLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: GeoJSONLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface GeoJSONLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): GeoJSONLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: GeoJSONLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface GeoJSONLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface GeoJSONLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface GeoJSONLayerGetFieldDomainOptions { feature: Graphic; } export interface GeoJSONLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface GeoJSONLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface GeoJSONLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface GeoJSONLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface GeoJSONLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } 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 { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#refreshInterval Read more...} */ refreshInterval: number; readonly type: "geo-rss"; /** * The URL pointing to a GeoRSS file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#url Read more...} */ url: string | nullish; /** * The GeoRSSLayer class is used to create a layer based on [GeoRSS](https://www.ogc.org/standards/georss). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html Read more...} */ constructor(properties?: GeoRSSLayerProperties); /** * Symbol used to represent line features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#lineSymbol Read more...} */ get lineSymbol(): SimpleLineSymbol | nullish; set lineSymbol(value: (SimpleLineSymbolProperties & { type: "simple-line" }) | nullish); /** * Symbol used to represent point features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#pointSymbol Read more...} */ get pointSymbol(): PictureMarkerSymbol | SimpleMarkerSymbol | nullish; set pointSymbol(value: | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | nullish); /** * Symbol used to represent polygon features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#polygonSymbol Read more...} */ get polygonSymbol(): SimpleFillSymbol | nullish; set polygonSymbol(value: (SimpleFillSymbolProperties & { type: "simple-fill" }) | nullish); /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#refresh Read more...} */ 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 { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * Symbol used to represent line features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#lineSymbol Read more...} */ lineSymbol?: (SimpleLineSymbolProperties & { type: "simple-line" }) | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Symbol used to represent point features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#pointSymbol Read more...} */ pointSymbol?: | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | nullish; /** * Symbol used to represent polygon features from the GeoRSS feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#polygonSymbol Read more...} */ polygonSymbol?: (SimpleFillSymbolProperties & { type: "simple-fill" }) | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#refreshInterval Read more...} */ refreshInterval?: number; /** * The URL pointing to a GeoRSS file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html#url Read more...} */ url?: string | nullish; } 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 { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; readonly type: "graphics"; /** * A GraphicsLayer contains one or more client-side {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphics}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html Read more...} */ constructor(properties?: GraphicsLayerProperties); /** * Specifies how graphics are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#elevationInfo Read more...} */ get elevationInfo(): GraphicsLayerElevationInfo | nullish; set elevationInfo(value: GraphicsLayerElevationInfoProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#graphics Read more...} */ get graphics(): Collection; set graphics(value: CollectionProperties); /** * Adds a graphic to the layer's graphic collection. * * @param graphic The graphic to add to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#add Read more...} */ add(graphic: Graphic): void; /** * Adds an array of graphics to the layer. * * @param graphics The graphic(s) to add to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#addMany Read more...} */ addMany(graphics: Graphic[]): void; /** * Removes a graphic from the layer. * * @param graphic The graphic to remove from the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#remove Read more...} */ remove(graphic: Graphic): void; /** * Clears all the graphics from the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#removeAll Read more...} */ removeAll(): void; /** * Removes an array of graphics from the layer. * * @param graphics The graphics to remove from the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#removeMany Read more...} */ removeMany(graphics: Graphic[]): void; } interface GraphicsLayerProperties extends LayerProperties, ScaleRangeLayerProperties, 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how graphics are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#elevationInfo Read more...} */ elevationInfo?: GraphicsLayerElevationInfoProperties | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#graphics Read more...} */ graphics?: CollectionProperties; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; } export interface GraphicsLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: GraphicsLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface GraphicsLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): GraphicsLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: GraphicsLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface GraphicsLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface GraphicsLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface GroupLayer extends Layer, LayersMixin, TablesMixin, PortalLayer, BlendLayer, OperationalLayer { } export class GroupLayer { /** * A flattened collection of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers} in the group layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#allLayers Read more...} */ readonly allLayers: Collection; /** * A flattened collection of tables anywhere in the group layer's hierarchy. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#allTables Read more...} */ readonly allTables: Collection; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#minScale Read more...} */ minScale: number; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; readonly type: "group"; /** * Indicates how to manage the visibility of the children layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#visibilityMode Read more...} */ visibilityMode: "independent" | "inherited" | "exclusive"; /** * GroupLayer provides the ability to organize several sublayers into one common layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html Read more...} */ constructor(properties?: GroupLayerProperties); /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties | Layer[]); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables * saved in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} and/or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#tables Read more...} */ get tables(): Collection; set tables(value: CollectionProperties | Layer[]); /** * Adds a layer to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. * * @param layer Layer or a promise that resolves to a layer to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#add Read more...} */ add(layer: Layer | Promise, index?: number): void; /** * Adds a layer or an array of layers to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. * * @param layers Layer(s) to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#addMany Read more...} */ addMany(layers: Layer[], index?: number): void; /** * Returns a layer based on the given layer ID. * * @param layerId The ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#findLayerById Read more...} */ findLayerById(layerId: string): Layer | nullish; /** * Returns a table based on the given table ID. * * @param tableId The ID assigned to the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#findTableById Read more...} */ findTableById(tableId: string): Layer | nullish; /** * Loads all the externally loadable resources associated with the group layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#loadAll Read more...} */ loadAll(): Promise; /** * Removes the specified layer from the layers collection. * * @param layer Layer to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#remove Read more...} */ remove(layer: Layer): Layer | nullish; /** * Removes all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#removeAll Read more...} */ removeAll(): Layer[]; /** * Removes the specified layers. * * @param layers Array of layers to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#removeMany Read more...} */ removeMany(layers: Layer[]): Layer[]; /** * Changes the layer order. * * @param layer The layer to be moved. * @param index The index location for placing the layer. The bottom-most layer has an index of `0`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#reorder Read more...} */ reorder(layer: Layer, index: number): Layer | nullish; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#save Read more...} */ save(options?: GroupLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: GroupLayerSaveAsOptions): Promise; static fromJSON(json: any): GroupLayer; } interface GroupLayerProperties extends LayerProperties, LayersMixinProperties, TablesMixinProperties, PortalLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#layers Read more...} */ layers?: CollectionProperties | Layer[]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#minScale Read more...} */ minScale?: number; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables * saved in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} and/or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#tables Read more...} */ tables?: CollectionProperties | Layer[]; /** * Indicates how to manage the visibility of the children layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html#visibilityMode Read more...} */ visibilityMode?: "independent" | "inherited" | "exclusive"; } export interface GroupLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface GroupLayerSaveOptions { ignoreUnsupported?: boolean; } export interface ImageryLayer extends Layer, GeoSceneImageService, OperationalLayer, PortalLayer, RasterPresetRendererMixin, RefreshableLayer, ScaleRangeLayer, TemporalLayer, BlendLayer, Clonable { } export class ImageryLayer { /** * The active preset renderer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#activePresetRendererName Read more...} */ declare activePresetRendererName: RasterPresetRendererMixin["activePresetRendererName"]; /** * Defines a band combination using 0-based band indexes. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#bandIds Read more...} */ declare bandIds: GeoSceneImageService["bandIds"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#capabilities Read more...} */ declare readonly capabilities: GeoSceneImageService["capabilities"]; /** * The compression quality value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#compressionQuality Read more...} */ declare compressionQuality: GeoSceneImageService["compressionQuality"]; /** * Controls the tolerance of the lerc compression algorithm. * * @default 0.01 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#compressionTolerance Read more...} */ declare compressionTolerance: GeoSceneImageService["compressionTolerance"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#copyright Read more...} */ declare copyright: GeoSceneImageService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#customParameters Read more...} */ customParameters: any; /** * Default mosaic rule of the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#defaultMosaicRule Read more...} */ declare readonly defaultMosaicRule: GeoSceneImageService["defaultMosaicRule"]; /** * The SQL where clause used to filter rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#definitionExpression Read more...} */ declare definitionExpression: GeoSceneImageService["definitionExpression"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#effect Read more...} */ effect: Effect | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fields Read more...} */ declare readonly fields: GeoSceneImageService["fields"]; /** * A convenient property that can be used to make case-insensitive lookups for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fields field} by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fieldsIndex Read more...} */ declare readonly fieldsIndex: GeoSceneImageService["fieldsIndex"]; /** * The format of the exported image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#format Read more...} */ declare format: GeoSceneImageService["format"]; /** * Indicates if the layer has {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#multidimensionalInfo multidimensionalInfo}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#hasMultidimensions Read more...} */ declare readonly hasMultidimensions: GeoSceneImageService["hasMultidimensions"]; /** * Indicates the maximum height of the image exported by the service. * * @default 4100 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageMaxHeight Read more...} */ declare imageMaxHeight: GeoSceneImageService["imageMaxHeight"]; /** * Indicates the maximum width of the image exported by the service. * * @default 15000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageMaxWidth Read more...} */ declare imageMaxWidth: GeoSceneImageService["imageMaxWidth"]; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#interpolation Read more...} */ declare interpolation: GeoSceneImageService["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The multidimensional information associated with the layer if the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#hasMultidimensions hasMultidimensions} property * is `true`. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#multidimensionalInfo Read more...} */ declare readonly multidimensionalInfo: GeoSceneImageService["multidimensionalInfo"]; /** * The pixel value representing no available information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noData Read more...} */ declare noData: GeoSceneImageService["noData"]; /** * Interpretation of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noData noData} setting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noDataInterpretation Read more...} */ declare noDataInterpretation: GeoSceneImageService["noDataInterpretation"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fields field} containing * a unique value or identifier for each raster in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#objectIdField Read more...} */ declare readonly objectIdField: GeoSceneImageService["objectIdField"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * A function that processes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#pixelData pixelData}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#pixelFilter Read more...} */ declare pixelFilter: GeoSceneImageService["pixelFilter"]; /** * Raster source pixel type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#pixelType Read more...} */ declare pixelType: GeoSceneImageService["pixelType"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * A list of preset renderers that defines a preferred renderer for a given multidimensional variable, a given raster function template, * or an additional generic predefined renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#presetRenderers Read more...} */ declare presetRenderers: RasterPresetRendererMixin["presetRenderers"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#rasterFields Read more...} */ declare readonly rasterFields: GeoSceneImageService["rasterFields"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#rasterFunctionInfos Read more...} */ declare readonly rasterFunctionInfos: GeoSceneImageService["rasterFunctionInfos"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Source raster information of the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#serviceRasterInfo Read more...} */ declare readonly serviceRasterInfo: GeoSceneImageService["serviceRasterInfo"]; /** * The [image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#sourceJSON Read more...} */ declare sourceJSON: GeoSceneImageService["sourceJSON"]; /** * Image service data source type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#sourceType Read more...} */ declare readonly sourceType: GeoSceneImageService["sourceType"]; /** * The spatial reference of the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#spatialReference Read more...} */ declare readonly spatialReference: GeoSceneImageService["spatialReference"]; readonly type: "imagery"; /** * The URL to the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#url Read more...} */ declare url: GeoSceneImageService["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The version of GeoScene Server in which the image service is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#version Read more...} */ declare readonly version: GeoSceneImageService["version"]; /** * Represents a dynamic [image service resource](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * as a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html Read more...} */ constructor(properties?: ImageryLayerProperties); /** * Defines how overlapping images should be mosaicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule; set mosaicRule(value: MosaicRuleProperties); /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#multidimensionalSubset Read more...} */ get multidimensionalSubset(): MultidimensionalSubset | nullish; set multidimensionalSubset(value: MultidimensionalSubsetProperties | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * Specifies the rule for how the requested image should be processed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#rasterFunction Read more...} */ get rasterFunction(): RasterFunction | nullish; set rasterFunction(value: RasterFunctionProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#renderer Read more...} */ get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer | nullish; set renderer(value: | (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" }) | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Calculates volume on the elevation data for the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#mosaicRule mosaicRule}, base surface type * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} geometries. * * @param parameters Specifies parameters for calculating volume. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume Read more...} */ calculateVolume(parameters: ImageVolumeParameters, requestOptions?: RequestOptions): Promise; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#clone Read more...} */ clone(): this; /** * Computes the rotation angle of a ImageryLayer at a given location. * * @param parameters Specifies parameters for computing angles. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeAngles Read more...} */ computeAngles(parameters: ImageAngleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes histograms based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param parameters Specifies parameters for computing histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeHistograms Read more...} */ computeHistograms(parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes the corresponding pixel location in columns and rows for an image based on input geometry. * * @param parameters Specifies parameters for computing image space pixel location. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computePixelSpaceLocations Read more...} */ computePixelSpaceLocations(parameters: ImagePixelLocationParameters, requestOptions?: RequestOptions): Promise; /** * Computes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterBandStatistics statistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterHistogram histograms} * for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param parameters Specifies parameters for computing statistics and histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeStatisticsHistograms Read more...} */ computeStatisticsHistograms(parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns an image using the * [export REST operation](https://doc.geoscene.cn/rest/services-reference/export-image.htm) that displays * data from an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * @deprecated since version 4.33. Use {@link module:geoscene/layers/ImageryLayer#fetchPixels ImageryLayer.fetchPixels} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fetchImage Read more...} */ fetchImage(extent: Extent, width: number, height: number, options?: GeoSceneImageServiceFetchImageOptions): Promise; /** * Fetches raw pixel data for a specified extent, width, and height, preserving full pixel depth and including all bands without applying renderer to the layer. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#fetchPixels Read more...} */ fetchPixels(extent: Extent, width: number, height: number, options?: GeoSceneImageServiceFetchPixelsOptions): Promise; /** * Finds images based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html FindImagesParameters}. * * @param parameters Specifies the find images parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#findImages Read more...} */ findImages(parameters: FindImagesParametersProperties, requestOptions?: RequestOptions): Promise; /** * Generates raster info for the specified raster function. * * @param rasterFunction Raster function for the requested raster info. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#generateRasterInfo Read more...} */ generateRasterInfo(rasterFunction: RasterFunctionProperties | nullish, options?: GeoSceneImageServiceGenerateRasterInfoOptions): Promise; /** * Gets the [image coordinate system](https://doc.geoscene.cn/rest/services-reference/raster-ics.htm) * information of a catalog item in an image service. * * @param rasterId Raster catalog id. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getCatalogItemICSInfo Read more...} */ getCatalogItemICSInfo(rasterId: number, options?: GeoSceneImageServiceGetCatalogItemICSInfoOptions): Promise; /** * Get the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html raster info} of a * [catalog item](https://doc.geoscene.cn/rest/services-reference/raster-catalog-item.htm) in an image service. * * @param rasterId Raster catalog id. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getCatalogItemRasterInfo Read more...} */ getCatalogItemRasterInfo(rasterId: number, options?: GeoSceneImageServiceGetCatalogItemRasterInfoOptions): Promise; /** * Retrieves an image's url using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html ImageUrlParameters}. * * @param parameters Specifies the image url parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getImageUrl Read more...} */ getImageUrl(parameters: ImageUrlParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples Read more...} */ getSamples(parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Sends a request to the GeoScene REST image service to identify content based on the * specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html ImageIdentifyParameters}. * * @param parameters The identify parameters used in the identify operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#identify Read more...} */ identify(parameters: ImageIdentifyParametersProperties, requestOptions?: RequestOptions): Promise; /** * Converts a geometry from an image space to a map space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html ImageToMapParameters}. * * @param parameters Specifies the image to map parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageToMap Read more...} */ imageToMap(parameters: ImageToMapParametersProperties, requestOptions?: RequestOptions): Promise; /** * Creates a map space geometry from multiray image space geometries using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html ImageToMapMultirayParameters}. * * @param parameters Specifies the image to map multiray parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageToMapMultiray Read more...} */ imageToMapMultiray(parameters: ImageToMapMultirayParametersProperties, requestOptions?: RequestOptions): Promise; /** * Converts a given geometry from a map space to an image space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html MapToImageParameters}. * * @param parameters Specifies the map to image parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mapToImage Read more...} */ mapToImage(parameters: MapToImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the area and perimeter of a given geometry on an image service. * * @param parameters Specifies parameters for measuring the area and perimeter for a given geometry on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaAndPerimeter Read more...} */ measureAreaAndPerimeter(parameters: ImageAreaParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param parameters Specifies parameters for measuring the area and the perimeter. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaFromImage Read more...} */ measureAreaFromImage(parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the distance and angle between two points on an image service. * * @param parameters Specifies parameters for measuring the distance and angle between two points on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureDistanceAndAngle Read more...} */ measureDistanceAndAngle(parameters: ImageDistanceParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the height of an object between two points on an image service if the sensor info is available. * * @param parameters Specifies parameters for measuring the height of an object between two points on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureHeight Read more...} */ measureHeight(parameters: ImageHeightParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param parameters Specifies parameters for measuring the length of a polyline. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureLengthFromImage Read more...} */ measureLengthFromImage(parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the location for a given point or centroid of a given area on an image service. * * @param parameters Specifies parameters for determining a point location or a centroid of a given area on the image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measurePointOrCentroid Read more...} */ measurePointOrCentroid(parameters: ImagePointParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the boundary of an image for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html ImageBoundaryParameters}. * * @param parameters Specifies the imagery boundary parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryBoundary Read more...} */ queryBoundary(parameters: ImageBoundaryParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns GPS information for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html ImageGPSInfoParameters}. * * @param parameters Specifies the parameters for query GPS info operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryGPSInfo Read more...} */ queryGPSInfo(parameters: ImageGPSInfoParametersProperties, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the image service and returns an * array of Object IDs for the rasters. * * @param query Specifies the query parameters. If no parameters are specified, then all Object IDs satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the image service and * returns the number of rasters that satisfy the query. * * @param query Specifies the query parameters. If no parameters are specified, then count of all rasters satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryRasterCount Read more...} */ queryRasterCount(query?: QueryProperties | null, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against an image service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the query parameters. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryRasters Read more...} */ queryRasters(query?: QueryProperties | nullish, requestOptions?: RequestOptions): Promise; /** * Executes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#pixelFilter pixelFilter} function and redraws the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#redraw Read more...} */ redraw(): void; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#refresh Read more...} */ refresh(): void; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#save Read more...} */ save(options?: ImageryLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#saveAs Read more...} */ saveAs(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, GeoSceneImageServiceProperties, OperationalLayerProperties, PortalLayerProperties, RasterPresetRendererMixinProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties { /** * The active preset renderer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#activePresetRendererName Read more...} */ activePresetRendererName?: RasterPresetRendererMixinProperties["activePresetRendererName"]; /** * Defines a band combination using 0-based band indexes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#bandIds Read more...} */ bandIds?: GeoSceneImageServiceProperties["bandIds"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The compression quality value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#compressionQuality Read more...} */ compressionQuality?: GeoSceneImageServiceProperties["compressionQuality"]; /** * Controls the tolerance of the lerc compression algorithm. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#compressionTolerance Read more...} */ compressionTolerance?: GeoSceneImageServiceProperties["compressionTolerance"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#copyright Read more...} */ copyright?: GeoSceneImageServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#customParameters Read more...} */ customParameters?: any; /** * The SQL where clause used to filter rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#definitionExpression Read more...} */ definitionExpression?: GeoSceneImageServiceProperties["definitionExpression"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The format of the exported image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#format Read more...} */ format?: GeoSceneImageServiceProperties["format"]; /** * Indicates the maximum height of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageMaxHeight Read more...} */ imageMaxHeight?: GeoSceneImageServiceProperties["imageMaxHeight"]; /** * Indicates the maximum width of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageMaxWidth Read more...} */ imageMaxWidth?: GeoSceneImageServiceProperties["imageMaxWidth"]; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#interpolation Read more...} */ interpolation?: GeoSceneImageServiceProperties["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Defines how overlapping images should be mosaicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties; /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#multidimensionalSubset Read more...} */ multidimensionalSubset?: MultidimensionalSubsetProperties | nullish; /** * The pixel value representing no available information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noData Read more...} */ noData?: GeoSceneImageServiceProperties["noData"]; /** * Interpretation of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noData noData} setting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#noDataInterpretation Read more...} */ noDataInterpretation?: GeoSceneImageServiceProperties["noDataInterpretation"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * A function that processes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#pixelData pixelData}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#pixelFilter Read more...} */ pixelFilter?: GeoSceneImageServiceProperties["pixelFilter"]; /** * Raster source pixel type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#pixelType Read more...} */ pixelType?: GeoSceneImageServiceProperties["pixelType"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A list of preset renderers that defines a preferred renderer for a given multidimensional variable, a given raster function template, * or an additional generic predefined renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#presetRenderers Read more...} */ presetRenderers?: RasterPresetRendererMixinProperties["presetRenderers"]; /** * Specifies the rule for how the requested image should be processed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#rasterFunction Read more...} */ rasterFunction?: RasterFunctionProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#renderer Read more...} */ 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" }) | nullish; /** * The [image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#sourceJSON Read more...} */ sourceJSON?: GeoSceneImageServiceProperties["sourceJSON"]; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL to the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#url Read more...} */ url?: GeoSceneImageServiceProperties["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } export interface ImageryLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface ImageryLayerSaveOptions { 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measurementValue Read more...} */ export interface MeasurementValueProperties { value?: number; uncertainty?: number | nullish; unit?: string; displayValue?: string; } /** * An object containing measurement values returned from a mensuration operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measurementValue Read more...} */ export interface MeasurementValue extends AnonymousAccessor { value: number; uncertainty: number | nullish; unit: string; displayValue: string; } /** * An object that provides the user access to * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixels pixels} and their values in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#PixelData Read more...} */ export interface PixelData { extent: Extent; pixelBlock: PixelBlock | nullish; } export type PixelFilterFunction = (pixelData: PixelData) => void; /** * Raster statistics information returned that meets the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters} * from the `computeStatisticsHistograms()` method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeStatisticsHistograms ImageryLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#computeStatisticsHistograms ImageryTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterBandStatistics Read more...} */ export interface RasterBandStatistics { min: number; max: number; avg?: number; stddev?: number; count?: number; mode?: number; median?: number; sum?: number; } /** * The raster function published with the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterFunctionInfo Read more...} */ export interface RasterFunctionInfo { name: string; description: string; help: string; functionType: number; thumbnail: string; } /** * Raster histogram information returned that meets the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters} * from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeHistograms computeHistograms()} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeStatisticsHistograms computeStatisticsHistograms()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterHistogram Read more...} */ export interface RasterHistogram { size: number; min: number; max: number; counts: number[] | Uint32Array; } export interface ImageryLayerRefreshEvent { dataChanged: boolean; } export interface ImageryTileLayer extends Layer, ImageryTileMixin, OperationalLayer, PortalLayer, RasterPresetRendererMixin, ScaleRangeLayer, BlendLayer, Clonable { } export class ImageryTileLayer { /** * The active preset renderer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#activePresetRendererName Read more...} */ declare activePresetRendererName: RasterPresetRendererMixin["activePresetRendererName"]; /** * Defines a band combination using 0-based band indexes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#bandIds Read more...} */ declare bandIds: ImageryTileMixin["bandIds"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#copyright Read more...} */ declare copyright: ImageryTileMixin["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#customParameters Read more...} */ customParameters: any; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#interpolation Read more...} */ declare interpolation: ImageryTileMixin["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#legendEnabled Read more...} */ declare legendEnabled: ImageryTileMixin["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The multidimensional definitions associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#multidimensionalDefinition Read more...} */ declare multidimensionalDefinition: ImageryTileMixin["multidimensionalDefinition"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * A list of preset renderers that defines a preferred renderer for a given multidimensional variable, a given raster function template, * or an additional generic predefined renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#presetRenderers Read more...} */ declare presetRenderers: RasterPresetRendererMixin["presetRenderers"]; /** * A complete list of fields that consists of service pixel value and vector fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#rasterFields Read more...} */ readonly rasterFields: Field[]; /** * Raster information retrieved from tiled imagery data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#serviceRasterInfo Read more...} */ declare readonly serviceRasterInfo: ImageryTileMixin["serviceRasterInfo"]; /** * The data source for client-side ImageryTileLayer can be a [coverage JSON](https://www.ogc.org/standard/coveragejson/) object * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#PixelData PixelData}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#source Read more...} */ source: any | PixelData | nullish; /** * The [tiled image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#sourceJSON Read more...} */ sourceJSON: any; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#spatialReference Read more...} */ declare readonly spatialReference: ImageryTileMixin["spatialReference"]; readonly type: "imagery-tile"; /** * The URL of the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#url Read more...} */ url: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#useViewTime Read more...} */ declare useViewTime: ImageryTileMixin["useViewTime"]; /** * The version of GeoScene Server in which the image service is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#version Read more...} */ readonly version: number | nullish; /** * ImageryTileLayer presents raster data from a tiled image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html Read more...} */ constructor(properties?: ImageryTileLayerProperties); /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#multidimensionalSubset Read more...} */ get multidimensionalSubset(): MultidimensionalSubset | nullish; set multidimensionalSubset(value: MultidimensionalSubsetProperties | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The client-side raster functions are operations that apply processing directly to the source image pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#rasterFunction Read more...} */ get rasterFunction(): RasterFunction | nullish; set rasterFunction(value: RasterFunctionProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#renderer Read more...} */ get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer | nullish; set renderer(value: | (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" }) | nullish); /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo | nullish; set tileInfo(value: TileInfoProperties | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#clone Read more...} */ clone(): this; /** * Computes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterBandStatistics statistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterHistogram histograms} * for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param parameters Specifies parameters for computing statistics and histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#computeStatisticsHistograms Read more...} */ computeStatisticsHistograms(parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Fetches pixels for a given extent. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#fetchPixels Read more...} */ fetchPixels(extent: Extent, width: number, height: number, options?: ImageryTileMixinFetchPixelsOptions): Promise; /** * This method fetches a tile for the given level, row and column present in the view. * * @param level Level of detail of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param row The row (y) position of the tile fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param col The column (x) position of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param options Optional settings for the tile request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#fetchTile Read more...} */ fetchTile(level: number, row: number, col: number, options?: ImageryTileLayerFetchTileOptions): Promise; /** * Generates a new raster info for the specified client side raster function. * * @param rasterFunction Raster function for the requested raster info. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#generateRasterInfo Read more...} */ generateRasterInfo(rasterFunction: RasterFunctionProperties | nullish, options?: ImageryTileLayerGenerateRasterInfoOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#getSamples Read more...} */ getSamples(parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Identify pixel values at a given location. * * @param point Input point that defines the location to be identified. * @param options Optional settings for the identify request. At version 4.25, the `transposedVariableName` was added to get pixel values from specific dimensional definitions if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer} references a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#hasMultidimensionalTranspose transposed multidimensional} image service. Set the `transposedVariableName` and `multidimensionalDefinition` get pixel values for the specified dimensional definitions from a transposed multidimensional service. If `multidimensionalDefinition` is not specified, pixel values will be returned from all the dimensional slices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#identify Read more...} */ identify(point: PointProperties, options?: RasterIdentifyOptions): Promise; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#save Read more...} */ save(options?: ImageryTileLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: ImageryTileLayerSaveAsOptions): Promise; static fromJSON(json: any): ImageryTileLayer; } interface ImageryTileLayerProperties extends LayerProperties, ImageryTileMixinProperties, OperationalLayerProperties, PortalLayerProperties, RasterPresetRendererMixinProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * The active preset renderer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#activePresetRendererName Read more...} */ activePresetRendererName?: RasterPresetRendererMixinProperties["activePresetRendererName"]; /** * Defines a band combination using 0-based band indexes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#bandIds Read more...} */ bandIds?: ImageryTileMixinProperties["bandIds"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#copyright Read more...} */ copyright?: ImageryTileMixinProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#customParameters Read more...} */ customParameters?: any; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#interpolation Read more...} */ interpolation?: ImageryTileMixinProperties["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#legendEnabled Read more...} */ legendEnabled?: ImageryTileMixinProperties["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The multidimensional definitions associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#multidimensionalDefinition Read more...} */ multidimensionalDefinition?: ImageryTileMixinProperties["multidimensionalDefinition"]; /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#multidimensionalSubset Read more...} */ multidimensionalSubset?: MultidimensionalSubsetProperties | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A list of preset renderers that defines a preferred renderer for a given multidimensional variable, a given raster function template, * or an additional generic predefined renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#presetRenderers Read more...} */ presetRenderers?: RasterPresetRendererMixinProperties["presetRenderers"]; /** * The client-side raster functions are operations that apply processing directly to the source image pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#rasterFunction Read more...} */ rasterFunction?: RasterFunctionProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#renderer Read more...} */ 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" }) | nullish; /** * The data source for client-side ImageryTileLayer can be a [coverage JSON](https://www.ogc.org/standard/coveragejson/) object * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#PixelData PixelData}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#source Read more...} */ source?: any | PixelData | nullish; /** * The [tiled image service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/image-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#sourceJSON Read more...} */ sourceJSON?: any; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL of the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#url Read more...} */ url?: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#useViewTime Read more...} */ useViewTime?: ImageryTileMixinProperties["useViewTime"]; } export interface ImageryTileLayerFetchTileOptions { signal?: AbortSignal | nullish; } export interface ImageryTileLayerGenerateRasterInfoOptions { signal?: AbortSignal | nullish; } export interface ImageryTileLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface ImageryTileLayerSaveOptions { ignoreUnsupported?: boolean; } /** * Additional options to set for `identify()` method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#identify ImageryTileLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#identify WCSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#RasterIdentifyOptions Read more...} */ export interface RasterIdentifyOptions { multidimensionalDefinition?: DimensionalDefinition[]; transposedVariableName?: string; signal?: AbortSignal | nullish; } /** * The result of `identify` operation on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#identify ImageryTileLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#identify WCSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#RasterIdentifyResult Read more...} */ export interface RasterIdentifyResult { location: Point; value: number[] | nullish; processedValue?: number[]; dataSeries?: RasterSliceValue[]; } /** * Data series returned in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#RasterIdentifyResult RasterIdentifyResult} when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#identify identify()} is called on a * transposed multidimensional ImageryTileLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#RasterSliceValue Read more...} */ export interface RasterSliceValue { value: number[] | nullish; multidimensionalDefinition: DimensionalDefinition[]; magdirValue?: number[]; } export interface IntegratedMesh3DTilesLayer extends Layer, PortalLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer, ScaleRangeLayer { } export class IntegratedMesh3DTilesLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; readonly type: "integrated-mesh-3dtiles"; /** * The URL of the root json file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#url Read more...} */ url: string | nullish; /** * The IntegratedMesh3DTilesLayer is designed for visualizing accurate representations of built and natural * environments in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html Read more...} */ constructor(properties?: IntegratedMesh3DTilesLayerProperties); /** * Specifies how the mesh is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#elevationInfo Read more...} */ get elevationInfo(): IntegratedMesh3DTilesLayerElevationInfo | nullish; set elevationInfo(value: IntegratedMesh3DTilesLayerElevationInfoProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html SceneModification} collection used to apply client-side * modifications to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#modifications Read more...} */ get modifications(): SceneModifications | nullish; set modifications(value: SceneModificationsProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); static fromJSON(json: any): IntegratedMesh3DTilesLayer; } interface IntegratedMesh3DTilesLayerProperties extends LayerProperties, PortalLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties, ScaleRangeLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Specifies how the mesh is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#elevationInfo Read more...} */ elevationInfo?: IntegratedMesh3DTilesLayerElevationInfoProperties | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html SceneModification} collection used to apply client-side * modifications to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#modifications Read more...} */ modifications?: SceneModificationsProperties | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The URL of the root json file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#url Read more...} */ url?: string | nullish; } export interface IntegratedMesh3DTilesLayerElevationInfoProperties { mode?: "absolute-height"; offset?: number | nullish; unit?: ElevationUnit | nullish; } export interface IntegratedMesh3DTilesLayerElevationInfo extends AnonymousAccessor { mode: "absolute-height"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface IntegratedMeshLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class IntegratedMeshLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#copyright Read more...} */ declare copyright: SceneService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#layerId Read more...} */ declare layerId: SceneService["layerId"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; readonly type: "integrated-mesh"; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#url Read more...} */ declare url: SceneService["url"]; /** * The version of the scene service specification used for this service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#version Read more...} */ declare readonly version: SceneService["version"]; /** * The IntegratedMeshLayer is designed for visualizing accurate representations of built and natural environments in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html Read more...} */ constructor(properties?: IntegratedMeshLayerProperties); /** * Specifies how the mesh is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#elevationInfo Read more...} */ get elevationInfo(): IntegratedMeshLayerElevationInfo | nullish; set elevationInfo(value: IntegratedMeshLayerElevationInfoProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html SceneModification} collection used to apply client-side * modifications to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#modifications Read more...} */ get modifications(): SceneModifications | nullish; set modifications(value: SceneModificationsProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#save Read more...} */ save(): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options additional save options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: IntegratedMeshLayerSaveAsOptions): Promise; static fromJSON(json: any): IntegratedMeshLayer; } interface IntegratedMeshLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#copyright Read more...} */ copyright?: SceneServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Specifies how the mesh is placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#elevationInfo Read more...} */ elevationInfo?: IntegratedMeshLayerElevationInfoProperties | nullish; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#layerId Read more...} */ layerId?: SceneServiceProperties["layerId"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html SceneModification} collection used to apply client-side * modifications to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#modifications Read more...} */ modifications?: SceneModificationsProperties | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#url Read more...} */ url?: SceneServiceProperties["url"]; } export interface IntegratedMeshLayerElevationInfoProperties { mode?: "absolute-height"; offset?: number | nullish; unit?: ElevationUnit | nullish; } export interface IntegratedMeshLayerElevationInfo extends AnonymousAccessor { mode: "absolute-height"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface IntegratedMeshLayerSaveAsOptions { folder?: PortalFolder; } export interface KMLLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, BlendLayer { } export class KMLLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; readonly type: "kml"; /** * The publicly accessible URL for a .kml or .kmz file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#url Read more...} */ url: string | nullish; /** * The KMLLayer class is used to create a layer based on a KML file (.kml, .kmz). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html Read more...} */ constructor(properties?: KMLLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html KMLSublayer}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); static fromJSON(json: any): KMLLayer; } interface KMLLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html KMLSublayer}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * The publicly accessible URL for a .kml or .kmz file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html#url Read more...} */ url?: string | nullish; } export interface KnowledgeGraphSublayer extends Layer, BlendLayer, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OrderedLayer, TemporalLayer { } export class KnowledgeGraphSublayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * The definition of the default popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#defaultPopupTemplate Read more...} */ readonly defaultPopupTemplate: PopupTemplate | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * The name of the sublayer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayField Read more...} */ displayField: string; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex | nullish; /** * The name of the geometry field for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryFieldName Read more...} */ geometryFieldName: string | nullish; /** * The geometry type of features in the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryType Read more...} */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | nullish; /** * Specifies whether the sublayer represents an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#graphType Read more...} */ graphType: "entity" | "relationship"; /** * Indicates whether the features in the sublayer have `M` (measurement) values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasM Read more...} */ hasM: boolean; /** * Indicates whether the features in the layer have `Z` (elevation) values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasZ Read more...} */ hasZ: boolean; /** * Indicates whether to display labels for this sublayer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#minScale Read more...} */ minScale: number; /** * The name of an `oid` containing * a unique value or identifier for each feature in the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectIdField Read more...} */ objectIdField: string; /** * Outlines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html type} definition for the named type represented by the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectType Read more...} */ objectType: GraphObjectType; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer} of which this is a sublayer for a specific entity or relationship type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#parentCompositeLayer Read more...} */ parentCompositeLayer: KnowledgeGraphLayer | LinkChartLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupEnabled Read more...} */ popupEnabled: boolean; readonly type: "knowledge-graph-sublayer"; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * A KnowledgeGraphSublayer is a sublayer of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html LinkChartLayer} * that contains all instances of a named type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html Read more...} */ constructor(properties?: KnowledgeGraphSublayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo Read more...} */ get elevationInfo(): KnowledgeGraphSublayerElevationInfo | nullish; set elevationInfo(value: KnowledgeGraphSublayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this sublayer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html label classes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameter object that can be used to fetch features that * satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression definitionExpression},. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: KnowledgeGraphSublayerGetFieldDomainOptions): Domain | nullish; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the knowledge graph service and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the sublayer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: KnowledgeGraphSublayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service} and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: KnowledgeGraphSublayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}, once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: KnowledgeGraphSublayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the knowledge graph service and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the sublayer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: KnowledgeGraphSublayerQueryObjectIdsOptions): Promise<(number | string)[]>; } interface KnowledgeGraphSublayerProperties extends LayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OrderedLayerProperties, TemporalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * The name of the sublayer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayField Read more...} */ displayField?: string; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#elevationInfo Read more...} */ elevationInfo?: KnowledgeGraphSublayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The name of the geometry field for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryFieldName Read more...} */ geometryFieldName?: string | nullish; /** * The geometry type of features in the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#geometryType Read more...} */ geometryType?: "point" | "multipoint" | "polyline" | "polygon" | nullish; /** * Specifies whether the sublayer represents an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#graphType Read more...} */ graphType?: "entity" | "relationship"; /** * Indicates whether the features in the sublayer have `M` (measurement) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasM Read more...} */ hasM?: boolean; /** * Indicates whether the features in the layer have `Z` (elevation) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#hasZ Read more...} */ hasZ?: boolean; /** * The label definition for this sublayer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html label classes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#minScale Read more...} */ minScale?: number; /** * The name of an `oid` containing * a unique value or identifier for each feature in the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Outlines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html type} definition for the named type represented by the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#objectType Read more...} */ objectType?: GraphObjectType; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer} of which this is a sublayer for a specific entity or relationship type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#parentCompositeLayer Read more...} */ parentCompositeLayer?: KnowledgeGraphLayer | LinkChartLayer; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } export interface KnowledgeGraphSublayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: KnowledgeGraphSublayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface KnowledgeGraphSublayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): KnowledgeGraphSublayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: KnowledgeGraphSublayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface KnowledgeGraphSublayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface KnowledgeGraphSublayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface KnowledgeGraphSublayerGetFieldDomainOptions { feature: Graphic; } export interface KnowledgeGraphSublayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface KnowledgeGraphSublayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface KnowledgeGraphSublayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface KnowledgeGraphSublayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export class KnowledgeGraphLayer extends Layer { /** * Defines a set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html named types} and/or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to be included in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#inclusionModeDefinition Read more...} */ inclusionModeDefinition: InclusionModeDefinition; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html data model}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html service definition} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#url url} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service} that contains the data for the KnowledgeGraphLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#knowledgeGraph Read more...} */ readonly knowledgeGraph: KnowledgeGraph; /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#layers Read more...} */ readonly layers: Collection; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} included in the KnowledgeGraphLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#memberEntityTypes Read more...} */ readonly memberEntityTypes: EntityType[]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} included in the KnowledgeGraphLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#memberRelationshipTypes Read more...} */ readonly memberRelationshipTypes: RelationshipType[]; /** * Contains the sublayer ids that have been cached. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#sublayerIdsCache Read more...} */ readonly sublayerIdsCache: globalThis.Map>; /** * All non-spatial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} * sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#tables Read more...} */ readonly tables: Collection; /** * The layer type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#type Read more...} */ readonly type: "knowledge-graph"; /** * The url of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#url Read more...} */ url: string | nullish; /** * A KnowledgeGraphLayer is a composite layer that can be created from a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html Read more...} */ constructor(properties?: KnowledgeGraphLayerProperties); /** * Adds new entities or relationships to the knowledge graph layer. * * @param records An array of the records to add to the knowledge graph layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#addRecords Read more...} */ addRecords(records: IdTypePair[]): Promise; convertSublayerToDynamicData(typeName: string): void; convertSublayerToExplicitMembership(typeName: string): void; convertToExplicitMembership(): void; convertToFullyDynamicData(): void; createSublayerForNamedType(typeName: string): Promise; /** * Assumes that data for all of the members defined in the inclusionModeDefinition is already loaded into local storage. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#loadLayerAssumingLocalCache Read more...} */ loadLayerAssumingLocalCache(): void; /** * Removes entities or relationships from the knowledge graph layer. * * @param records The id and entity type or relationship type of the record to be added to the knowledge graph layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#removeRecords Read more...} */ removeRecords(records: IdTypePair[]): Promise; } interface KnowledgeGraphLayerProperties extends LayerProperties { /** * Defines a set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html named types} and/or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to be included in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#inclusionModeDefinition Read more...} */ inclusionModeDefinition?: InclusionModeDefinition; /** * The url of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#url Read more...} */ url?: string | nullish; } /** * The id and named type of a record to be added or removed from the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#IdTypePair Read more...} */ export interface IdTypePair { id: string; typeName: string; } /** * Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#InclusionModeDefinition Read more...} */ export interface InclusionModeDefinition { generateAllSublayers: boolean; namedTypeDefinitions: globalThis.Map; } /** * Defines the contents of each specified named type in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#inclusionModeDefinition `inclusionModeDefinition`} and whether all instance of the named type will be used or a specified subset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#LayerInclusionDefinition Read more...} */ export interface LayerInclusionDefinition { useAllData: boolean; members?: globalThis.Map; } /** * Defines the list of `members` for a named type in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#inclusionModeDefinition `inclusionModeDefinition`}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html#LayerInclusionMemberDefinition Read more...} */ export interface LayerInclusionMemberDefinition { id: string; } export interface Layer extends Accessor, Loadable, Evented, Identifiable { } export class Layer { /** * The unique ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#id Read more...} */ id: string; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * @default "show" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode Read more...} */ listMode: "show" | "hide" | "hide-children"; /** * Indicates whether the layer's resources have loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The opacity of the layer. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#opacity Read more...} */ opacity: number; /** * The parent to which the layer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#parent Read more...} */ parent: Map | Basemap | Ground | GroupLayer | CatalogDynamicGroupLayer | CatalogLayer | nullish; /** * When `true`, the layer can be persisted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#persistenceEnabled Read more...} */ readonly persistenceEnabled: boolean; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#title Read more...} */ title: string | nullish; /** * The layer type provides a convenient way to check the type of the layer * without the need to import specific layer modules. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#type Read more...} */ readonly type: | "base-dynamic" | "base-elevation" | "base-tile" | "bing-maps" | "building-scene" | "catalog" | "catalog-dynamic-group" | "catalog-footprint" | "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" | "parquet" | "point-cloud" | "route" | "scene" | "georeferenced-image" | "stream" | "tile" | "unknown" | "unsupported" | "vector-tile" | "viewshed" | "wcs" | "web-tile" | "wfs" | "wms" | "wmts" | "video" | "voxel" | "subtype-group" | "knowledge-graph" | "knowledge-graph-sublayer" | "link-chart"; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates if the layer is visible in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#visible Read more...} */ visible: boolean; /** * The layer is the most fundamental component of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Read more...} */ constructor(properties?: LayerProperties); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * Specifies a fixed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} during which a layer should be visible. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#visibilityTimeExtent Read more...} */ get visibilityTimeExtent(): TimeExtent | nullish; set visibilityTimeExtent(value: TimeExtentProperties | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Called by the views, such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}, when the layer is added to the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers Map.layers} collection and a layer view must * be created for it. * * @param view The parent view. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#createLayerView Read more...} */ createLayerView(view: any, options?: LayerCreateLayerViewOptions): Promise; /** * Destroys the layer and any associated resources (including its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#portalItem portalItem}, if it is a property on the layer). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#destroy Read more...} */ destroy(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Fetches custom attribution data for the layer when it becomes available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#fetchAttributionData Read more...} */ fetchAttributionData(): Promise; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#when Read more...} */ when(callback?: Function, errback?: Function): 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 GeoScene Server URL. * * @param params Input parameters for creating the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#fromGeoSceneServerUrl Read more...} */ static fromGeoSceneServerUrl(params: LayerFromGeoSceneServerUrlParams): Promise; /** * Creates a new layer instance of the appropriate layer class from an * GeoScene Online or GeoScene Enterprise * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * @param params The parameters for loading the portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#fromPortalItem Read more...} */ static fromPortalItem(params: LayerFromPortalItemParams): Promise; } interface LayerProperties extends LoadableProperties, IdentifiableProperties { /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The unique ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#id Read more...} */ id?: string; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode Read more...} */ listMode?: "show" | "hide" | "hide-children"; /** * The opacity of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#opacity Read more...} */ opacity?: number; /** * The parent to which the layer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#parent Read more...} */ parent?: Map | Basemap | Ground | GroupLayer | CatalogDynamicGroupLayer | CatalogLayer | nullish; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#title Read more...} */ title?: string | nullish; /** * Specifies a fixed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} during which a layer should be visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#visibilityTimeExtent Read more...} */ visibilityTimeExtent?: TimeExtentProperties | nullish; /** * Indicates if the layer is visible in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#visible Read more...} */ visible?: boolean; } export interface LayerCreateLayerViewOptions { signal?: AbortSignal | nullish; } export interface LayerFromGeoSceneServerUrlParams { url: string; properties?: any; } export interface LayerFromPortalItemParams { 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 { /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; readonly type: "line-of-sight"; /** * The line of sight layer enables the creation and display of visibility analysis where a line of sight * is computed from a single observer position towards * a set of targets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html Read more...} */ constructor(properties?: LineOfSightLayerProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html LineOfSightAnalysis} associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#analysis Read more...} */ get analysis(): LineOfSightAnalysis; set analysis(value: LineOfSightAnalysisProperties); /** * The observer defines the point from which the line of sight analysis is performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#observer Read more...} */ get observer(): LineOfSightAnalysisObserver | nullish; set observer(value: LineOfSightAnalysisObserverProperties | nullish); /** * Target locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#targets Read more...} */ get targets(): Collection | nullish; set targets(value: CollectionProperties | nullish); static fromJSON(json: any): LineOfSightLayer; } interface LineOfSightLayerProperties extends LayerProperties, OperationalLayerProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html LineOfSightAnalysis} associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#analysis Read more...} */ analysis?: LineOfSightAnalysisProperties; /** * The observer defines the point from which the line of sight analysis is performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#observer Read more...} */ observer?: LineOfSightAnalysisObserverProperties | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Target locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#targets Read more...} */ targets?: CollectionProperties | nullish; } export class LinkChartLayer extends Layer { /** * Defines a set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html named types} and/or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to be included in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationInclusionModeDefinition Read more...} */ initializationInclusionModeDefinition: LinkChartLayerInclusionModeDefinition; /** * The default configuration options for a new link chart layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationLinkChartConfig Read more...} */ initializationLinkChartConfig: InitializationLinkChartConfig | nullish; /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html sublayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#layers Read more...} */ readonly layers: Collection; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} included in the LinkChartLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#memberEntityTypes Read more...} */ memberEntityTypes: EntityType[]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} included in the LinkChartLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#memberRelationshipTypes Read more...} */ memberRelationshipTypes: RelationshipType[]; /** * All non-spatial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html sublayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#tables Read more...} */ readonly tables: Collection; /** * The url of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#url Read more...} */ url: string | nullish; /** * A LinkChartLayer is a composite layer that can be created from a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html Read more...} */ constructor(properties?: LinkChartLayerProperties); /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#calculateLinkChartLayout Calculates} the layout for the link chart and refreshes the canvas with the new layout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#applyNewLinkChartLayout Read more...} */ applyNewLinkChartLayout(): void; /** * Loads layer assuming that data for all of the members defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationInclusionModeDefinition initializationInclusionModeDefinition} is already loaded into local storage. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#loadLayerAssumingLocalCache Read more...} */ loadLayerAssumingLocalCache(): void; } interface LinkChartLayerProperties extends LayerProperties { /** * Defines a set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html named types} and/or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to be included in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationInclusionModeDefinition Read more...} */ initializationInclusionModeDefinition?: LinkChartLayerInclusionModeDefinition; /** * The default configuration options for a new link chart layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationLinkChartConfig Read more...} */ initializationLinkChartConfig?: InitializationLinkChartConfig | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} included in the LinkChartLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#memberEntityTypes Read more...} */ memberEntityTypes?: EntityType[]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} included in the LinkChartLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#memberRelationshipTypes Read more...} */ memberRelationshipTypes?: RelationshipType[]; /** * The url of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#url Read more...} */ url?: string | nullish; } /** * Defines the sublayer structure and the named types that will be in the LinkChartLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#InclusionModeDefinition Read more...} */ export interface LinkChartLayerInclusionModeDefinition { generateAllSublayers: boolean; namedTypeDefinitions: globalThis.Map; } /** * Defines the initial layout for the link chart and any layout settings for newly created link chart layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationLinkChartConfig Read more...} */ export interface InitializationLinkChartConfig { layoutMode?: | "organic-standard" | "organic-community" | "basic-grid" | "hierarchical-bottom-to-top" | "radial-root-centric" | "tree-left-to-right" | "geographic-organic-standard" | "chronological-mono-timeline" | "chronological-multi-timeline"; doNotRecalculateLayout?: boolean; layoutSettings?: LayoutSettings; } /** * Defines the contents of each specified named type in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationInclusionModeDefinition `initializationInclusionModeDefinition`} and whether all instance of the named type will be used or a specified subset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#LayerInclusionDefinition Read more...} */ export interface LinkChartLayerLayerInclusionDefinition { useAllData: boolean; members?: globalThis.Map; } /** * Defines the list of `members` for a named type in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#initializationInclusionModeDefinition `initializationInclusionModeDefinition`}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html#LayerInclusionMemberDefinition Read more...} */ export interface LinkChartLayerLayerInclusionMemberDefinition { id: string; linkChartLocation?: Point; } export interface MapImageLayer extends Layer, SublayersOwner, GeoSceneMapService, ScaleRangeLayer, RefreshableLayer, TemporalLayer, BlendLayer, CustomParametersMixin, OperationalLayer { } export class MapImageLayer { /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sublayers sublayers} * in the MapImageLayer including the sublayers of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#allSublayers Read more...} */ readonly allSublayers: Collection; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Indicates the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#capabilities Read more...} */ declare readonly capabilities: GeoSceneMapService["capabilities"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#copyright Read more...} */ declare copyright: GeoSceneMapService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#dateFieldsTimeZone Read more...} */ readonly dateFieldsTimeZone: string | nullish; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#datesInUnknownTimezone Read more...} */ readonly datesInUnknownTimezone: boolean; /** * The output dots per inch (DPI) of the MapImageLayer. * * @default 96 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#dpi Read more...} */ dpi: number; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The version of the geodatabase of the map service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * The output image type. * * @default "png24" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageFormat Read more...} */ imageFormat: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "pngjpg"; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageMaxHeight Read more...} */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageMaxWidth Read more...} */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageTransparency Read more...} */ imageTransparency: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#legendEnabled Read more...} */ declare legendEnabled: GeoSceneMapService["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#preferredTimeZone Read more...} */ readonly preferredTimeZone: string | nullish; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * The [map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sourceJSON Read more...} */ sourceJSON: any | nullish; /** * The spatial reference of the layer as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#spatialReference Read more...} */ declare readonly spatialReference: GeoSceneMapService["spatialReference"]; readonly type: "map-image"; /** * The URL to the REST endpoint of the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#url Read more...} */ url: string | nullish; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The version of GeoScene Server in which the map service is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#version Read more...} */ declare readonly version: GeoSceneMapService["version"]; /** * MapImageLayer allows you to display and analyze data from * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sublayers sublayers} defined in a * [map service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-map-service.htm), exporting images * instead of features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html Read more...} */ constructor(properties?: MapImageLayerProperties); /** * The full extent of the layer as defined by the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer} objects * that allow you to alter * the properties of one or more sublayers of the MapImageLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the tables * in the layer including the tables of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#subtables Read more...} */ get subtables(): Collection | nullish; set subtables(value: CollectionProperties | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Gets the parameters of the exported image to use when calling the * [export REST operation](https://doc.geoscene.cn/rest/services-reference/export-map.htm). * * @param extent The extent of the exported image * @param width The width of the exported image * @param height The height of the exported image * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#createExportImageParameters Read more...} */ createExportImageParameters(extent: Extent | nullish, width: number, height: number, options?: MapImageLayerCreateExportImageParametersOptions): any; /** * Returns a deep clone of a map service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html sublayers} as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#createServiceSublayers Read more...} */ createServiceSublayers(): Collection; /** * This method fetches the image for the specified extent and size. * * @param extent The extent of the view. * @param width The width of the view in pixels. * @param height The height of the view in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#fetchImage Read more...} */ fetchImage(extent: Extent, width: number, height: number, options?: MapImageLayerFetchImageOptions): Promise; /** * Returns the sublayer with the given layerId. * * @param id The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#id id} of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#findSublayerById Read more...} */ findSublayerById(id: number): Sublayer | nullish; /** * Loads all of the sublayers and subtables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#loadAll Read more...} */ loadAll(): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#refresh Read more...} */ refresh(): void; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#save Read more...} */ save(options?: MapImageLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: MapImageLayerSaveAsOptions): 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, SublayersOwnerProperties, GeoSceneMapServiceProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, TemporalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, OperationalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#copyright Read more...} */ copyright?: GeoSceneMapServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The output dots per inch (DPI) of the MapImageLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#dpi Read more...} */ dpi?: number; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The full extent of the layer as defined by the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The version of the geodatabase of the map service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The output image type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageFormat Read more...} */ imageFormat?: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "pngjpg"; /** * Indicates the maximum height of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageMaxHeight Read more...} */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageMaxWidth Read more...} */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#imageTransparency Read more...} */ imageTransparency?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#legendEnabled Read more...} */ legendEnabled?: GeoSceneMapServiceProperties["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The [map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sourceJSON Read more...} */ sourceJSON?: any | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer} objects * that allow you to alter * the properties of one or more sublayers of the MapImageLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the tables * in the layer including the tables of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#subtables Read more...} */ subtables?: CollectionProperties | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL to the REST endpoint of the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#url Read more...} */ url?: string | nullish; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } export interface MapImageLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface MapImageLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface MapImageLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface MapImageLayerCreateExportImageParametersOptions { rotation?: number; pixelRatio?: number; timeExtent?: any; } export interface MapImageLayerFetchImageOptions { rotation?: number; pixelRatio?: number; timeExtent?: any; signal?: AbortSignal | nullish; } export interface MapImageLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface MapImageLayerSaveOptions { ignoreUnsupported?: boolean; } export interface MapImageLayerRefreshEvent { dataChanged: boolean; } export interface MapNotesLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, BlendLayer { } export class MapNotesLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#capabilities Read more...} */ readonly capabilities: MapNotesLayerCapabilities; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * A layer containing a collection of graphics with multipoint geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#multipointLayer Read more...} */ readonly multipointLayer: GraphicsLayer | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * A layer containing a collection of graphics with point geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#pointLayer Read more...} */ readonly pointLayer: GraphicsLayer | nullish; /** * A layer containing a collection of graphics with polygon geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#polygonLayer Read more...} */ readonly polygonLayer: GraphicsLayer | nullish; /** * A layer containing a collection of graphics with polyline geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#polylineLayer Read more...} */ readonly polylineLayer: GraphicsLayer | nullish; /** * A layer containing a collection of text graphics with point geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#textLayer Read more...} */ readonly textLayer: GraphicsLayer | nullish; 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.geosceneonline.cn/geoscene/apps/mapviewer/index.html). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html Read more...} */ constructor(properties?: MapNotesLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); static fromJSON(json: any): MapNotesLayer; } interface MapNotesLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapNotesLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; } export interface MapNotesLayerCapabilities { operations: MapNotesLayerCapabilitiesOperations; } export interface MapNotesLayerCapabilitiesOperations { supportsMapNotesEditing: boolean; } export interface MediaLayer extends Layer, ScaleRangeLayer, PortalLayer, BlendLayer, OperationalLayer { } export class MediaLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#copyright Read more...} */ copyright: string | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; readonly type: "media"; /** * The MediaLayer class is used to add {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html image} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html video} * elements to the map at a specified geographic {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference location}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html Read more...} */ constructor(properties?: MediaLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The source for the MediaLayer that will be displayed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source Read more...} */ get source(): ImageElement | VideoElement | LocalMediaElementSource | nullish; set source(value: | (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) | LocalMediaElementSourceProperties | nullish | Collection | MediaElement[]); /** * The spatial reference of the layer and defines the spatial reference of the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#fullExtent fullExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#save Read more...} */ save(options?: MediaLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: MediaLayerSaveAsOptions): Promise; static fromJSON(json: any): MediaLayer; } interface MediaLayerProperties extends LayerProperties, ScaleRangeLayerProperties, PortalLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The source for the MediaLayer that will be displayed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source Read more...} */ source?: | (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) | LocalMediaElementSourceProperties | nullish | Collection | MediaElement[]; /** * The spatial reference of the layer and defines the spatial reference of the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#fullExtent fullExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; } export interface MediaLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface MediaLayerSaveOptions { ignoreUnsupported?: boolean; } export class APIKeyMixin { apiKey: string | nullish; } interface APIKeyMixinProperties { apiKey?: string | nullish; } export class GeoSceneCachedService { copyright: string | nullish; readonly spatialReference: SpatialReference; constructor(properties?: GeoSceneCachedServiceProperties); get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); static fromJSON(json: any): GeoSceneCachedService; } interface GeoSceneCachedServiceProperties { copyright?: string | nullish; tileInfo?: TileInfoProperties; } export class GeoSceneImageService { bandIds: number[] | nullish; readonly capabilities: GeoSceneImageServiceCapabilities; compressionQuality: number | nullish; compressionTolerance: number; copyright: string | nullish; readonly defaultMosaicRule: MosaicRule | nullish; definitionExpression: string | nullish; readonly fields: Field[]; readonly fieldsIndex: FieldsIndex | nullish; format: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "jpgpng" | "lerc" | "tiff" | "bip" | "bsq"; readonly hasMultidimensions: boolean; imageMaxHeight: number; imageMaxWidth: number; interpolation: "nearest" | "bilinear" | "cubic" | "majority"; readonly multidimensionalInfo: RasterMultidimensionalInfo | nullish; noData: number | number[] | nullish; noDataInterpretation: "any" | "all" | nullish; readonly objectIdField: string; pixelFilter: PixelFilterFunction | nullish; pixelType: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128" | nullish; readonly rasterFields: Field[]; readonly rasterFunctionInfos: RasterFunctionInfo[] | nullish; readonly serviceRasterInfo: RasterInfo; sourceJSON: any; readonly sourceType: "mosaic-dataset" | "raster-dataset"; readonly spatialReference: SpatialReference; url: string | nullish; readonly version: number; constructor(properties?: GeoSceneImageServiceProperties); get mosaicRule(): MosaicRule; set mosaicRule(value: MosaicRuleProperties); get multidimensionalSubset(): MultidimensionalSubset | nullish; set multidimensionalSubset(value: MultidimensionalSubsetProperties | nullish); get rasterFunction(): RasterFunction | nullish; set rasterFunction(value: RasterFunctionProperties | nullish); get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer | nullish; set renderer(value: | (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" }) | nullish); /** * Calculates volume on the elevation data for the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#mosaicRule mosaicRule}, base surface type * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} geometries. * * @param parameters Specifies parameters for calculating volume. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#calculateVolume Read more...} */ calculateVolume(parameters: ImageVolumeParameters, requestOptions?: RequestOptions): Promise; /** * Computes the rotation angle of a ImageryLayer at a given location. * * @param parameters Specifies parameters for computing angles. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#computeAngles Read more...} */ computeAngles(parameters: ImageAngleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes histograms based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param parameters Specifies parameters for computing histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#computeHistograms Read more...} */ computeHistograms(parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes the corresponding pixel location in columns and rows for an image based on input geometry. * * @param parameters Specifies parameters for computing image space pixel location. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#computePixelSpaceLocations Read more...} */ computePixelSpaceLocations(parameters: ImagePixelLocationParameters, requestOptions?: RequestOptions): Promise; /** * Computes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterBandStatistics statistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterHistogram histograms} * for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param parameters Specifies parameters for computing statistics and histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#computeStatisticsHistograms Read more...} */ computeStatisticsHistograms(parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns an image using the * [export REST operation](https://doc.geoscene.cn/rest/services-reference/export-image.htm) that displays * data from an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * @deprecated since version 4.33. Use {@link module:geoscene/layers/ImageryLayer#fetchPixels ImageryLayer.fetchPixels} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#fetchImage Read more...} */ fetchImage(extent: Extent, width: number, height: number, options?: GeoSceneImageServiceFetchImageOptions): Promise; /** * Fetches raw pixel data for a specified extent, width, and height, preserving full pixel depth and including all bands without applying renderer to the layer. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#fetchPixels Read more...} */ fetchPixels(extent: Extent, width: number, height: number, options?: GeoSceneImageServiceFetchPixelsOptions): Promise; /** * Finds images based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html FindImagesParameters}. * * @param parameters Specifies the find images parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#findImages Read more...} */ findImages(parameters: FindImagesParametersProperties, requestOptions?: RequestOptions): Promise; /** * Generates raster info for the specified raster function. * * @param rasterFunction Raster function for the requested raster info. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#generateRasterInfo Read more...} */ generateRasterInfo(rasterFunction: RasterFunctionProperties | nullish, options?: GeoSceneImageServiceGenerateRasterInfoOptions): Promise; /** * Gets the [image coordinate system](https://doc.geoscene.cn/rest/services-reference/raster-ics.htm) * information of a catalog item in an image service. * * @param rasterId Raster catalog id. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#getCatalogItemICSInfo Read more...} */ getCatalogItemICSInfo(rasterId: number, options?: GeoSceneImageServiceGetCatalogItemICSInfoOptions): Promise; /** * Get the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html raster info} of a * [catalog item](https://doc.geoscene.cn/rest/services-reference/raster-catalog-item.htm) in an image service. * * @param rasterId Raster catalog id. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#getCatalogItemRasterInfo Read more...} */ getCatalogItemRasterInfo(rasterId: number, options?: GeoSceneImageServiceGetCatalogItemRasterInfoOptions): Promise; /** * Retrieves an image's url using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html ImageUrlParameters}. * * @param parameters Specifies the image url parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#getImageUrl Read more...} */ getImageUrl(parameters: ImageUrlParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#getSamples Read more...} */ getSamples(parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Sends a request to the GeoScene REST image service to identify content based on the * specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html ImageIdentifyParameters}. * * @param parameters The identify parameters used in the identify operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#identify Read more...} */ identify(parameters: ImageIdentifyParametersProperties, requestOptions?: RequestOptions): Promise; /** * Converts a geometry from an image space to a map space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html ImageToMapParameters}. * * @param parameters Specifies the image to map parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#imageToMap Read more...} */ imageToMap(parameters: ImageToMapParametersProperties, requestOptions?: RequestOptions): Promise; /** * Creates a map space geometry from multiray image space geometries using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html ImageToMapMultirayParameters}. * * @param parameters Specifies the image to map multiray parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#imageToMapMultiray Read more...} */ imageToMapMultiray(parameters: ImageToMapMultirayParametersProperties, requestOptions?: RequestOptions): Promise; /** * Converts a given geometry from a map space to an image space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html MapToImageParameters}. * * @param parameters Specifies the map to image parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#mapToImage Read more...} */ mapToImage(parameters: MapToImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the area and perimeter of a given geometry on an image service. * * @param parameters Specifies parameters for measuring the area and perimeter for a given geometry on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measureAreaAndPerimeter Read more...} */ measureAreaAndPerimeter(parameters: ImageAreaParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param parameters Specifies parameters for measuring the area and the perimeter. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measureAreaFromImage Read more...} */ measureAreaFromImage(parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the distance and angle between two points on an image service. * * @param parameters Specifies parameters for measuring the distance and angle between two points on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measureDistanceAndAngle Read more...} */ measureDistanceAndAngle(parameters: ImageDistanceParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the height of an object between two points on an image service if the sensor info is available. * * @param parameters Specifies parameters for measuring the height of an object between two points on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measureHeight Read more...} */ measureHeight(parameters: ImageHeightParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param parameters Specifies parameters for measuring the length of a polyline. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measureLengthFromImage Read more...} */ measureLengthFromImage(parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the location for a given point or centroid of a given area on an image service. * * @param parameters Specifies parameters for determining a point location or a centroid of a given area on the image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#measurePointOrCentroid Read more...} */ measurePointOrCentroid(parameters: ImagePointParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the boundary of an image for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html ImageBoundaryParameters}. * * @param parameters Specifies the imagery boundary parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#queryBoundary Read more...} */ queryBoundary(parameters: ImageBoundaryParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns GPS information for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html ImageGPSInfoParameters}. * * @param parameters Specifies the parameters for query GPS info operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#queryGPSInfo Read more...} */ queryGPSInfo(parameters: ImageGPSInfoParametersProperties, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the image service and returns an * array of Object IDs for the rasters. * * @param query Specifies the query parameters. If no parameters are specified, then all Object IDs satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the image service and * returns the number of rasters that satisfy the query. * * @param query Specifies the query parameters. If no parameters are specified, then count of all rasters satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#queryRasterCount Read more...} */ queryRasterCount(query?: QueryProperties | null, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against an image service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the query parameters. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-GeoSceneImageService.html#queryRasters Read more...} */ queryRasters(query?: QueryProperties | nullish, requestOptions?: RequestOptions): Promise; static fromJSON(json: any): GeoSceneImageService; } interface GeoSceneImageServiceProperties { bandIds?: number[] | nullish; compressionQuality?: number | nullish; compressionTolerance?: number; copyright?: string | nullish; definitionExpression?: string | nullish; format?: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "jpgpng" | "lerc" | "tiff" | "bip" | "bsq"; imageMaxHeight?: number; imageMaxWidth?: number; interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; mosaicRule?: MosaicRuleProperties; multidimensionalSubset?: MultidimensionalSubsetProperties | nullish; noData?: number | number[] | nullish; noDataInterpretation?: "any" | "all" | nullish; pixelFilter?: PixelFilterFunction | nullish; pixelType?: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128" | nullish; rasterFunction?: RasterFunctionProperties | nullish; 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" }) | nullish; sourceJSON?: any; url?: string | nullish; } export interface GeoSceneImageServiceCapabilities { mensuration: GeoSceneImageServiceCapabilitiesMensuration; operations: GeoSceneImageServiceCapabilitiesOperations; query: GeoSceneImageServiceCapabilitiesQuery; } export interface GeoSceneImageServiceCapabilitiesMensuration { supports3D: boolean; supportsAreaAndPerimeter: boolean; supportsDistanceAndAngle: boolean; supportsHeightFromBaseAndTop: boolean; supportsHeightFromBaseAndTopShadow: boolean; supportsHeightFromTopAndTopShadow: boolean; supportsPointOrCentroid: boolean; } export interface GeoSceneImageServiceCapabilitiesOperations { supportsComputeHistograms: boolean; supportsExportImage: boolean; supportsIdentify: boolean; supportsMeasure: boolean; supportsImageToMap: boolean; supportsImageToMapMultiray: boolean; supportsFindImages: boolean; supportsGetImageUrl: boolean; supportsMapToImage: boolean; supportsDownload: boolean; supportsQuery: boolean; supportsGetSamples: boolean; supportsProject: boolean; supportsComputeStatisticsHistograms: boolean; supportsQueryBoundary: boolean; supportsQueryGPSInfo: boolean; supportsCalculateVolume: boolean; supportsComputePixelLocation: boolean; } export interface GeoSceneImageServiceCapabilitiesQuery { supportsStatistics: boolean; supportsSqlExpression: boolean; supportsOrderBy: boolean; supportsDistinct: boolean; supportsPagination: boolean; supportsStandardizedQueriesOnly: boolean; supportsTrueCurve: boolean; maxRecordCount: number | nullish; } export interface GeoSceneImageServiceFetchImageOptions { signal?: AbortSignal | nullish; } export interface GeoSceneImageServiceFetchPixelsOptions { interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; applyRendering?: boolean; signal?: AbortSignal | nullish; } export interface GeoSceneImageServiceGenerateRasterInfoOptions { signal?: AbortSignal | nullish; } export interface GeoSceneImageServiceGetCatalogItemICSInfoOptions { signal?: AbortSignal | nullish; } export interface GeoSceneImageServiceGetCatalogItemRasterInfoOptions { signal?: AbortSignal | nullish; } export class GeoSceneMapService { readonly capabilities: GeoSceneMapServiceCapabilities; copyright: string | nullish; legendEnabled: boolean; readonly spatialReference: SpatialReference; readonly version: number; constructor(properties?: GeoSceneMapServiceProperties); get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); static fromJSON(json: any): GeoSceneMapService; } interface GeoSceneMapServiceProperties { copyright?: string | nullish; fullExtent?: ExtentProperties | nullish; legendEnabled?: boolean; } export interface GeoSceneMapServiceCapabilities { exportMap: GeoSceneMapServiceCapabilitiesExportMap | nullish; exportTiles: GeoSceneMapServiceCapabilitiesExportTiles | nullish; operations: GeoSceneMapServiceCapabilitiesOperations; } export interface GeoSceneMapServiceCapabilitiesExportMap { supportsArcadeExpressionForLabeling: boolean; supportsDynamicLayers: boolean; supportsSublayersChanges: boolean; supportsSublayerDefinitionExpression: boolean; supportsSublayerOrderBy: boolean; supportsSublayerVisibility: boolean; supportsCIMSymbols: boolean; } export interface GeoSceneMapServiceCapabilitiesExportTiles { maxExportTilesCount: number; } export interface GeoSceneMapServiceCapabilitiesOperations { supportsExportMap: boolean; supportsExportTiles: boolean; supportsIdentify: boolean; supportsQuery: boolean; supportsTileMap: boolean; } export class BlendLayer { 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: Effect | nullish; } interface BlendLayerProperties { 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?: Effect | nullish; } export class CustomParametersMixin { customParameters: any | nullish; } interface CustomParametersMixinProperties { customParameters?: any | nullish; } export class DisplayFilteredLayer { displayFilterEnabled: boolean; displayFilterInfo: DisplayFilterInfo | nullish; } interface DisplayFilteredLayerProperties { displayFilterEnabled?: boolean; displayFilterInfo?: DisplayFilterInfo | nullish; } export class FeatureEffectLayer { get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); } interface FeatureEffectLayerProperties { featureEffect?: FeatureEffectProperties | nullish; } export class FeatureLayerBase { readonly capabilities: Capabilities | nullish; copyright: string | nullish; dateFieldsTimeZone: string | nullish; readonly datesInUnknownTimezone: boolean; definitionExpression: string | nullish; displayField: string | nullish; readonly editFieldsInfo: EditFieldsInfo | nullish; readonly editingInfo: EditingInfo | nullish; readonly effectiveCapabilities: Capabilities | nullish; readonly effectiveEditingEnabled: boolean; readonly fieldsIndex: FieldsIndex; gdbVersion: string | nullish; readonly geometryFieldsInfo: GeometryFieldsInfo | nullish; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh" | nullish; globalIdField: string | nullish; hasM: boolean; hasZ: boolean; readonly isTable: boolean; layerId: number | nullish; objectIdField: string; readonly preferredTimeZone: string | nullish; readonly relationships: Relationship[] | nullish; returnM: boolean | nullish; returnZ: boolean | nullish; readonly serviceDefinitionExpression: string | nullish; readonly serviceItemId: string | nullish; sourceJSON: any | nullish; readonly subtypeField: string | nullish; readonly subtypes: Subtype[] | nullish; title: string | nullish; url: string | nullish; readonly version: number | nullish; get elevationInfo(): FeatureLayerBaseElevationInfo | nullish; set elevationInfo(value: FeatureLayerBaseElevationInfoProperties | nullish); get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-FeatureLayerBase.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-FeatureLayerBase.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: FeatureLayerBaseGetFieldDomainOptions): Domain | nullish; } interface FeatureLayerBaseProperties { copyright?: string | nullish; dateFieldsTimeZone?: string | nullish; definitionExpression?: string | nullish; displayField?: string | nullish; elevationInfo?: FeatureLayerBaseElevationInfoProperties | nullish; floorInfo?: LayerFloorInfoProperties | nullish; fullExtent?: ExtentProperties | nullish; gdbVersion?: string | nullish; geometryType?: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh" | nullish; globalIdField?: string | nullish; hasM?: boolean; hasZ?: boolean; historicMoment?: DateProperties | nullish; layerId?: number | nullish; objectIdField?: string; returnM?: boolean | nullish; returnZ?: boolean | nullish; sourceJSON?: any | nullish; spatialReference?: SpatialReferenceProperties; title?: string | nullish; url?: string | nullish; } export interface FeatureLayerBaseElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: FeatureLayerBaseElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface FeatureLayerBaseElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): FeatureLayerBaseElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: FeatureLayerBaseElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface FeatureLayerBaseElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface FeatureLayerBaseElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface FeatureLayerBaseGetFieldDomainOptions { feature: Graphic; } export class FeatureReductionLayer { get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); } interface FeatureReductionLayerProperties { featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; } export class ImageryTileMixin { bandIds: number[] | nullish; copyright: string | nullish; interpolation: "nearest" | "bilinear" | "cubic" | "majority"; legendEnabled: boolean; multidimensionalDefinition: DimensionalDefinition[] | nullish; readonly serviceRasterInfo: RasterInfo | nullish; readonly spatialReference: SpatialReference; useViewTime: boolean; get multidimensionalSubset(): MultidimensionalSubset | nullish; set multidimensionalSubset(value: MultidimensionalSubsetProperties | nullish); get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer | nullish; set renderer(value: | (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" }) | nullish); get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Fetches pixels for a given extent. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-ImageryTileMixin.html#fetchPixels Read more...} */ fetchPixels(extent: Extent, width: number, height: number, options?: ImageryTileMixinFetchPixelsOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-ImageryTileMixin.html#getSamples Read more...} */ getSamples(parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Identify pixel values at a given location. * * @param point Input point that defines the location to be identified. * @param options Optional settings for the identify request. At version 4.25, the `transposedVariableName` was added to get pixel values from specific dimensional definitions if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer} references a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#hasMultidimensionalTranspose transposed multidimensional} image service. Set the `transposedVariableName` and `multidimensionalDefinition` get pixel values for the specified dimensional definitions from a transposed multidimensional service. If `multidimensionalDefinition` is not specified, pixel values will be returned from all the dimensional slices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-ImageryTileMixin.html#identify Read more...} */ identify(point: PointProperties, options?: RasterIdentifyOptions): Promise; } interface ImageryTileMixinProperties { bandIds?: number[] | nullish; copyright?: string | nullish; interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; legendEnabled?: boolean; multidimensionalDefinition?: DimensionalDefinition[] | nullish; multidimensionalSubset?: MultidimensionalSubsetProperties | nullish; 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" }) | nullish; timeExtent?: TimeExtentProperties | nullish; timeInfo?: TimeInfoProperties | nullish; timeOffset?: TimeIntervalProperties | nullish; useViewTime?: boolean; } export interface ImageryTileMixinFetchPixelsOptions { interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; signal?: AbortSignal | nullish; } export class OperationalLayer { persistenceEnabled: boolean; constructor(properties?: OperationalLayerProperties); static fromJSON(json: any): OperationalLayer; } interface OperationalLayerProperties { persistenceEnabled?: boolean; } export class OrderedLayer { get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); } interface OrderedLayerProperties { orderBy?: OrderByInfoProperties[] | nullish; } export class PortalLayer { constructor(properties?: PortalLayerProperties); get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); static fromJSON(json: any): PortalLayer; } interface PortalLayerProperties { portalItem?: PortalItemProperties | nullish; } export class PublishableLayer { readonly publishingInfo: PublishingInfo | nullish; } interface PublishableLayerProperties { } export class RasterPresetRendererMixin { activePresetRendererName: string | nullish; presetRenderers: RasterPresetRenderer[] | nullish; } interface RasterPresetRendererMixinProperties { activePresetRendererName?: string | nullish; presetRenderers?: RasterPresetRenderer[] | nullish; } export class RefreshableLayer { refreshInterval: number; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-RefreshableLayer.html#refresh Read more...} */ refresh(): void; } interface RefreshableLayerProperties { refreshInterval?: number; } export class ScaleRangeLayer { maxScale: number; minScale: number; } interface ScaleRangeLayerProperties { maxScale?: number; minScale?: number; } export class SceneService { copyright: string | nullish; layerId: number; url: string | nullish; readonly version: SceneServiceVersion; constructor(properties?: SceneServiceProperties); get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); static fromJSON(json: any): SceneService; } interface SceneServiceProperties { copyright?: string | nullish; layerId?: number; spatialReference?: SpatialReferenceProperties; url?: string | nullish; } export interface SceneServiceVersion { major: number; minor: number; versionString: string; } export class SublayersOwner { get subtables(): Collection | nullish; set subtables(value: CollectionProperties | nullish); /** * Returns a deep clone of a map service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html sublayers} as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-SublayersOwner.html#createServiceSublayers Read more...} */ createServiceSublayers(): Collection; /** * Returns the sublayer with the given layerId. * * @param id The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#id id} of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-mixins-SublayersOwner.html#findSublayerById Read more...} */ findSublayerById(id: number): Sublayer | nullish; } interface SublayersOwnerProperties { subtables?: CollectionProperties | nullish; } export class TemporalLayer { useViewTime: boolean; get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); } interface TemporalLayerProperties { timeExtent?: TimeExtentProperties | nullish; timeInfo?: TimeInfoProperties | nullish; timeOffset?: TimeIntervalProperties | nullish; useViewTime?: boolean; } export class TemporalSceneLayer { get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); } interface TemporalSceneLayerProperties { timeExtent?: TimeExtentProperties | nullish; timeInfo?: TimeInfoProperties | nullish; timeOffset?: TimeIntervalProperties | nullish; } export class TrackableLayer { get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); } interface TrackableLayerProperties { trackInfo?: TrackInfoProperties | nullish; } /** * Provides utility functions for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html WCSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wcsUtils.html Read more...} */ interface wcsUtils { /** * Fetches the capabilities metadata offered by the WCS service, including supported versions and coverages information. * * @param url The URL to the WCS service endpoint. * @param options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wcsUtils.html#getCapabilities Read more...} */ getCapabilities(url: string, options?: wcsUtilsGetCapabilitiesOptions): Promise; } export const wcsUtils: wcsUtils; /** * Coverage information associated with a WCS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wcsUtils.html#CoverageBrief Read more...} */ export interface CoverageBrief { id?: string; lonLatEnvelope?: Extent; coverageSubType?: string; } /** * A list of URLs for the WCS service resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wcsUtils.html#OnlineResources Read more...} */ export interface OnlineResources { getCapabilities: string; describeCoverage: string; getCoverage: string; } /** * WCS service information about the available coverages, versions, extensions and more. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wcsUtils.html#WCSCapabilities Read more...} */ export interface WCSCapabilities { name: string; onlineResources: OnlineResources; coverages: CoverageBrief[]; gridCoverages: CoverageBrief[]; supportedVersions: string[]; version: "1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1"; supportedFormats?: string[]; profiles?: string[]; supportedInterpolations?: string[]; } export interface wcsUtilsGetCapabilitiesOptions { version?: "1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1"; customParameters?: any; signal?: AbortSignal | nullish; } /** * Provides utility functions for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html Read more...} */ 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. * * @param url The URL to the WFS endpoint. * @param options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#getCapabilities Read more...} */ getCapabilities(url: string, options?: wfsUtilsGetCapabilitiesOptions): Promise; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#WFSLayerInfo WFSLayerInfo} from the capabilities of the WFS service. * * @param capabilities The capabilities of the WFS service. * @param name The type name to get information for. If not specified, the first layer of the service is chosen. * @param namespaceUri The namespace URI of the type name. If not specified, the first namespace found for the `name` is chosen. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#getWFSLayerInfo Read more...} */ getWFSLayerInfo(capabilities: WFSCapabilities, name?: string | null, namespaceUri?: string | null, options?: wfsUtilsGetWFSLayerInfoOptions): Promise; } export const wfsUtils: wfsUtils; /** * WFS service information about the available layers and operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#WFSCapabilities Read more...} */ export interface WFSCapabilities { operations: WFSOperations; featureTypes: WFSFeatureType[]; } /** * Provides information about an individual feature type, or layer, found in the WFS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#WFSFeatureType Read more...} */ export interface WFSFeatureType { typeName: string; name: string; title: string; description: string; extent: Extent | nullish; namespacePrefix: string; namespaceUri: string; defaultSpatialReference: number; supportedSpatialReferences: number[]; } /** * The layer info from the WFS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#WFSLayerInfo Read more...} */ export interface WFSLayerInfo { url: string; name: string; namespaceUri: string; fields: Field[]; geometryType: "point" | "multipoint" | "polyline" | "polygon"; objectIdField: string; spatialReference: SpatialReference; extent: Extent | nullish; swapXY: boolean; wfsCapabilities: WFSCapabilities; customParameters?: any | nullish; } /** * Information about some operations of the WFS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#WFSOperations Read more...} */ export interface WFSOperations { GetCapabilities: WFSOperationsGetCapabilities; DescribeFeatureType: WFSOperationsDescribeFeatureType; GetFeature: WFSOperationsGetFeature; } export interface wfsUtilsGetCapabilitiesOptions { customParameters?: any; signal?: AbortSignal | nullish; } export interface wfsUtilsGetWFSLayerInfoOptions { customParameters?: any; spatialReference?: any; signal?: AbortSignal | nullish; } export interface WFSOperationsDescribeFeatureType { url: string; } export interface WFSOperationsGetCapabilities { url: string; } export interface WFSOperationsGetFeature { url: string; outputFormat: string | nullish; supportsPagination: boolean; } export interface OGCFeatureLayer extends Layer, APIKeyMixin, BlendLayer, CustomParametersMixin, DisplayFilteredLayer, OperationalLayer, OrderedLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, FeatureEffectLayer, FeatureReductionLayer, TrackableLayer { } export class OGCFeatureLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * The unique identifier of the collection on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#collectionId Read more...} */ collectionId: string; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * Description of the features in the collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#description Read more...} */ readonly description: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#geometryType Read more...} */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * Explicitly set the maximum number of features that can be returned in a single request. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#maxRecordCount Read more...} */ maxRecordCount: number | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The OGCFeatureLayer requires that each feature be uniquely identified with an object id. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#objectIdField Read more...} */ objectIdField: string; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; /** * The spatial reference the source data is stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; readonly type: "ogc-feature"; /** * The URL to the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#url Read more...} */ url: string; /** * The OGCFeatureLayer class is used to create a layer based on individual collections from a * [OGC API Features](https://ogcapi.ogc.org/features/) service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html Read more...} */ constructor(properties?: OGCFeatureLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#elevationInfo Read more...} */ get elevationInfo(): OGCFeatureLayerElevationInfo | nullish; set elevationInfo(value: OGCFeatureLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#renderer Read more...} */ get renderer(): RendererUnion; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#refresh Read more...} */ refresh(): void; 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, DisplayFilteredLayerProperties, OperationalLayerProperties, OrderedLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, TrackableLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The unique identifier of the collection on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#collectionId Read more...} */ collectionId?: string; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#elevationInfo Read more...} */ elevationInfo?: OGCFeatureLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#geometryType Read more...} */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * Explicitly set the maximum number of features that can be returned in a single request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#maxRecordCount Read more...} */ maxRecordCount?: number | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The OGCFeatureLayer requires that each feature be uniquely identified with an object id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }); /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The URL to the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html#url Read more...} */ 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 OGCFeatureLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: OGCFeatureLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface OGCFeatureLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): OGCFeatureLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: OGCFeatureLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface OGCFeatureLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface OGCFeatureLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface OGCFeatureLayerRefreshEvent { dataChanged: boolean; } export class OpenStreetMapLayer extends WebTileLayer { /** * The subdomains used to access the tile service. * * @default ["a", "b", "c"] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OpenStreetMapLayer.html#subDomains Read more...} */ readonly subDomains: string[]; readonly type: "open-street-map"; /** * The URL template used to access the tile service. * * @default "https://{subDomain}.tile.openstreetmap.org/{level}/{col}/{row}.png" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OpenStreetMapLayer.html#urlTemplate Read more...} */ readonly urlTemplate: string; /** * Allows you to use [basemaps](http://wiki.openstreetmap.org/wiki/List_of_OSM-based_services) from [OpenStreetMap](http://www.openstreetmap.org/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OpenStreetMapLayer.html Read more...} */ constructor(properties?: OpenStreetMapLayerProperties); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OpenStreetMapLayer.html#fullExtent Read more...} */ get fullExtent(): Extent; on(name: "refresh", eventHandler: OpenStreetMapLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: OpenStreetMapLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: OpenStreetMapLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: OpenStreetMapLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): OpenStreetMapLayer; } interface OpenStreetMapLayerProperties extends WebTileLayerProperties { } export interface OpenStreetMapLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface OpenStreetMapLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface OpenStreetMapLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface OpenStreetMapLayerRefreshEvent { dataChanged: boolean; } /** * Provides the utility function to convert image coordinates to geographic coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html Read more...} */ interface imageToWorld { /** * Transforms image coordinates in pixels to a point or an array of points specifying the corresponding geographic world coordinates. * * @param pixelOrPixels A single `Pixel` object or an `ArrayOrCollection` representing the image coordinates in `x` and `y` (in rows and columns) to be transformed. Here (0, 0) corresponds to the center of the upper left pixel. * @param properties An object containing the properties required for the transformation, such as camera location, rotation matrix, and image dimensions. * @param updateElevationProps An object containing the properties required for correcting the elevation of the output point, resulting in a more accurate z-value. This is an optional parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#imageToWorld Read more...} */ imageToWorld(pixelOrPixels: imageToWorldPixelLocation | imageToWorldPixelLocation[], properties: ImageToWorldProperties, updateElevationProps?: UpdateElevationProps): Promise; } export const imageToWorld: imageToWorld; /** * Represents the properties required for transforming image coordinates to world coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#ImageToWorldProperties Read more...} */ export interface ImageToWorldProperties { averageElevation: number; cameraPitch: number; cameraRoll: number; farDistance: number; affineTransformations: [number, number, number, number, number, number]; cameraLocation: any; focalLength: number; principalOffsetPoint?: [number, number]; radialDistortionCoefficients?: [number, number, number]; rotationMatrix: [number, number, number, number, number, number, number, number, number]; tangentialDistortionCoefficients?: [number, number]; horizontalFieldOfView: number; verticalFieldOfView: number; imageHeight: number; imageWidth: number; } /** * Represents the pixel location in image space, where (0, 0) corresponds to the center of the upper left pixel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#PixelLocation Read more...} */ export interface imageToWorldPixelLocation { x: number; y: number; } /** * Represents the properties required for updating the elevation of the output point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#UpdateElevationProps Read more...} */ export type UpdateElevationProps = UpdateElevationPropsWithSampler | UpdateElevationPropsWithConstant; /** * Represents the properties required for updating the elevation of the output point with a constant value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#UpdateElevationPropsWithConstant Read more...} */ export interface UpdateElevationPropsWithConstant { elevationSource: UpdateElevationPropsWithConstantElevationSource; } /** * Represents the properties required for updating the elevation of the output point with an elevation sampler. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-imageToWorld.html#UpdateElevationPropsWithSampler Read more...} */ export interface UpdateElevationPropsWithSampler { elevationSample: ElevationSampler; } export interface UpdateElevationPropsWithConstantElevationSource { constantElevation: number; } /** * Provides the utility function to convert geographic coordinates to image coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-worldToImage.html Read more...} */ interface worldToImage { /** * Transforms a point or an array of points from geographic world coordinates to image space coordinates. * * @param pointOrPoints A single `Point` or an array or collection of points representing the geographic coordinates to be transformed. * @param properties An object containing the properties required for the transformation, such as camera location (selected feature), affineTransformations, rotation matrix, focalLength, imageHeight, imageWidth, horizontalFieldOfView and verticalFieldOfView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-worldToImage.html#worldToImage Read more...} */ worldToImage(pointOrPoints: Point | Point[] | Collection, properties: WorldToImageProperties): PixelLocation | PixelLocation[]; } export const worldToImage: worldToImage; /** * Represents the pixel location in image space, where (0, 0) corresponds to the center of the upper left pixel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-worldToImage.html#PixelLocation Read more...} */ export interface PixelLocation { x: number; y: number; } /** * Represents the properties required for transforming world coordinates to image coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-orientedImagery-transformations-worldToImage.html#WorldToImageProperties Read more...} */ export interface WorldToImageProperties { affineTransformations: [number, number, number, number, number, number]; cameraLocation: any; focalLength: number; principalOffsetPoint?: [number, number]; radialDistortionCoefficients?: [number, number, number]; rotationMatrix: [number, number, number, number, number, number, number, number, number]; tangentialDistortionCoefficients?: [number, number]; horizontalFieldOfView: number; verticalFieldOfView: number; imageHeight: number; imageWidth: number; } export interface OrientedImageryLayer extends Layer, BlendLayer, DisplayFilteredLayer, OrderedLayer, ScaleRangeLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, Clonable { } export class OrientedImageryLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Camera orientation defining the first rotation around z-axis of the camera. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraHeading Read more...} */ cameraHeading: number | nullish; /** * The height of camera above the ground when the imagery was captured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraHeight Read more...} */ cameraHeight: number | nullish; /** * Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraPitch Read more...} */ cameraPitch: number | nullish; /** * Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraRoll Read more...} */ cameraRoll: number | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#copyright Read more...} */ copyright: string | nullish; /** * Modifies the extent of the image's ground footprint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#coveragePercent Read more...} */ coveragePercent: number | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * Prefix used to build the DEM url path in conjunction with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource elevationSource} attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#demPathPrefix Read more...} */ demPathPrefix: string | nullish; /** * Suffix used to build the DEM url path in conjunction with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource elevationSource} attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#demPathSuffix Read more...} */ demPathSuffix: string | nullish; /** * Prefix used to build the depth image url path in conjunction with the depth image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#depthImagePathPrefix Read more...} */ depthImagePathPrefix: string | nullish; /** * Suffix used to build the depth image url path in conjunction with the depth image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#depthImagePathSuffix Read more...} */ depthImagePathSuffix: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The source of elevation, that will be used to compute ground to image transformations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource Read more...} */ elevationSource: ConstantElevation | ElevationSource | nullish; /** * The farthest usable distance of the imagery from the camera position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#farDistance Read more...} */ farDistance: number | nullish; /** * The geometry type of features in the OrientedImageryLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#geometryType Read more...} */ geometryType: "point"; /** * The camera's scope in horizontal direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#horizontalFieldOfView Read more...} */ horizontalFieldOfView: number | nullish; /** * Defines the unit that will be used for all horizontal measurements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#horizontalMeasurementUnit Read more...} */ horizontalMeasurementUnit: string | nullish; /** * Prefix used to build the image url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imagePathPrefix Read more...} */ imagePathPrefix: string | nullish; /** * Suffix used to build the image url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imagePathSuffix Read more...} */ imagePathSuffix: string | nullish; /** * The orientation of the camera in degrees relative to the scene when the image was captured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imageRotation Read more...} */ imageRotation: number | nullish; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * A unique id that identifies an operational layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#layerId Read more...} */ readonly layerId: number; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#maximumDistance Read more...} */ maximumDistance: number | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The nearest usable distance of the imagery from the camera position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#nearDistance Read more...} */ nearDistance: number | nullish; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#objectIdField Read more...} */ objectIdField: string; /** * Semicolon-delimited string used to store standard deviation values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orientationAccuracy Read more...} */ orientationAccuracy: number[]; /** * String that defines the imagery type used in the particular Oriented Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orientedImageryType Read more...} */ orientedImageryType: | "horizontal" | "nadir" | "oblique" | "360" | "inspection" | "terrestrial-frame-video" | "aerial-frame-video" | "terrestrial-360-video" | "aerial-360-video" | nullish; /** * An array of field names to include in the OrientedImageryLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Defines the unit of time used in the viewer's time selector tool. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#timeIntervalUnit Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#type Read more...} */ readonly type: "oriented-imagery"; /** * The URL of the Oriented Imagery layer service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#url Read more...} */ url: string | nullish; /** * The camera's scope in the vertical direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#verticalFieldOfView Read more...} */ verticalFieldOfView: number | nullish; /** * Defines the primary unit to be used for all vertical measurements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#verticalMeasurementUnit Read more...} */ verticalMeasurementUnit: "feet" | "meter" | nullish; /** * Prefix used to build the video url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#videoPathPrefix Read more...} */ videoPathPrefix: string | nullish; /** * Suffix used to build the video url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#videoPathSuffix Read more...} */ videoPathSuffix: string | nullish; /** * An Oriented Imagery Layer is a single spatial layer that can be created from a * [Feature Service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-feature-service-.htm); or * GeoScene Online or GeoScene Enterprise portal items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html Read more...} */ constructor(properties?: OrientedImageryLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationInfo Read more...} */ get elevationInfo(): OrientedImageryLayerElevationInfo | nullish; set elevationInfo(value: OrientedImageryLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item referencing the Oriented Imagery layer item from which the OrientedImageryLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#clone Read more...} */ clone(): this; /** * Creates query parameters that can be used to fetch features that * satisfy the layer's current filters, and definitions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: OrientedImageryLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the Oriented Imagery features and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: OrientedImageryLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: OrientedImageryLayerQueryObjectIdsOptions): Promise<(number | string)[]>; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#save Read more...} */ save(options?: OrientedImageryLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: OrientedImageryLayerSaveAsOptions): Promise; static fromJSON(json: any): OrientedImageryLayer; } interface OrientedImageryLayerProperties extends LayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Camera orientation defining the first rotation around z-axis of the camera. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraHeading Read more...} */ cameraHeading?: number | nullish; /** * The height of camera above the ground when the imagery was captured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraHeight Read more...} */ cameraHeight?: number | nullish; /** * Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraPitch Read more...} */ cameraPitch?: number | nullish; /** * Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#cameraRoll Read more...} */ cameraRoll?: number | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * Modifies the extent of the image's ground footprint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#coveragePercent Read more...} */ coveragePercent?: number | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * Prefix used to build the DEM url path in conjunction with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource elevationSource} attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#demPathPrefix Read more...} */ demPathPrefix?: string | nullish; /** * Suffix used to build the DEM url path in conjunction with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource elevationSource} attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#demPathSuffix Read more...} */ demPathSuffix?: string | nullish; /** * Prefix used to build the depth image url path in conjunction with the depth image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#depthImagePathPrefix Read more...} */ depthImagePathPrefix?: string | nullish; /** * Suffix used to build the depth image url path in conjunction with the depth image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#depthImagePathSuffix Read more...} */ depthImagePathSuffix?: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationInfo Read more...} */ elevationInfo?: OrientedImageryLayerElevationInfoProperties | nullish; /** * The source of elevation, that will be used to compute ground to image transformations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#elevationSource Read more...} */ elevationSource?: ConstantElevation | ElevationSource | nullish; /** * The farthest usable distance of the imagery from the camera position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#farDistance Read more...} */ farDistance?: number | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the OrientedImageryLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#geometryType Read more...} */ geometryType?: "point"; /** * The camera's scope in horizontal direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#horizontalFieldOfView Read more...} */ horizontalFieldOfView?: number | nullish; /** * Defines the unit that will be used for all horizontal measurements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#horizontalMeasurementUnit Read more...} */ horizontalMeasurementUnit?: string | nullish; /** * Prefix used to build the image url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imagePathPrefix Read more...} */ imagePathPrefix?: string | nullish; /** * Suffix used to build the image url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imagePathSuffix Read more...} */ imagePathSuffix?: string | nullish; /** * The orientation of the camera in degrees relative to the scene when the image was captured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#imageRotation Read more...} */ imageRotation?: number | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#maximumDistance Read more...} */ maximumDistance?: number | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The nearest usable distance of the imagery from the camera position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#nearDistance Read more...} */ nearDistance?: number | nullish; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * Semicolon-delimited string used to store standard deviation values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orientationAccuracy Read more...} */ orientationAccuracy?: number[]; /** * String that defines the imagery type used in the particular Oriented Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#orientedImageryType Read more...} */ orientedImageryType?: | "horizontal" | "nadir" | "oblique" | "360" | "inspection" | "terrestrial-frame-video" | "aerial-frame-video" | "terrestrial-360-video" | "aerial-360-video" | nullish; /** * An array of field names to include in the OrientedImageryLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item referencing the Oriented Imagery layer item from which the OrientedImageryLayer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * Defines the unit of time used in the viewer's time selector tool. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#timeIntervalUnit Read more...} */ timeIntervalUnit?: "days" | "hours" | "minutes" | "months" | "weeks" | "years"; /** * The URL of the Oriented Imagery layer service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#url Read more...} */ url?: string | nullish; /** * The camera's scope in the vertical direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#verticalFieldOfView Read more...} */ verticalFieldOfView?: number | nullish; /** * Defines the primary unit to be used for all vertical measurements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#verticalMeasurementUnit Read more...} */ verticalMeasurementUnit?: "feet" | "meter" | nullish; /** * Prefix used to build the video url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#videoPathPrefix Read more...} */ videoPathPrefix?: string | nullish; /** * Suffix used to build the video url path in conjunction with the image attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#videoPathSuffix Read more...} */ videoPathSuffix?: string | nullish; } /** * The unit of constant elevation value measured in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#ConstantElevation Read more...} */ export interface ConstantElevation { constantElevation: number; } /** * The elevation source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html#ElevationSource Read more...} */ export interface ElevationSource { url: string; rasterFunction?: string | nullish; lod: number | nullish; } export interface OrientedImageryLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: OrientedImageryLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface OrientedImageryLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): OrientedImageryLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: OrientedImageryLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface OrientedImageryLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface OrientedImageryLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface OrientedImageryLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface OrientedImageryLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface OrientedImageryLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface OrientedImageryLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface OrientedImageryLayerSaveOptions { ignoreUnsupported?: boolean; } export interface ParquetLayer extends Layer, BlendLayer, CustomParametersMixin, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, OrderedLayer, ScaleRangeLayer { } export class ParquetLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#geometryType Read more...} */ geometryType: "point" | "polygon" | "polyline" | "multipoint"; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#objectIdField Read more...} */ objectIdField: string; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; readonly type: "parquet"; /** * The ParquetLayer enables visualization of [parquet files](https://parquet.apache.org/docs/) on a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html Read more...} */ constructor(properties?: ParquetLayerProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Collection of urls for parquet files. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#urls Read more...} */ get urls(): Collection; set urls(value: CollectionProperties); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: ParquetLayerGetFieldDomainOptions): Domain | nullish; static fromJSON(json: any): ParquetLayer; } interface ParquetLayerProperties extends LayerProperties, BlendLayerProperties, CustomParametersMixinProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties, OrderedLayerProperties, ScaleRangeLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#geometryType Read more...} */ geometryType?: "point" | "polygon" | "polyline" | "multipoint"; /** * The label definition for this layer, specified as an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * Collection of urls for parquet files. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html#urls Read more...} */ urls?: CollectionProperties; } export interface ParquetLayerGetFieldDomainOptions { feature: Graphic; } export class PointCloudBitfieldFilter extends PointCloudFilter { /** * An array of bit positions where the bit value must be `0`, otherwise the point will not be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html#requiredClearBits Read more...} */ requiredClearBits: number[] | nullish; /** * An array of bit positions where the bit value must be `1`, otherwise the point will not be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html#requiredSetBits Read more...} */ requiredSetBits: number[] | nullish; /** * For PointCloudBitfieldFilter the type is always `bitfield`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html#type Read more...} */ readonly type: "bitfield"; /** * Points can be classified using flags that indicate special characteristics associated with the point like * the direction of the flight or the method used to create the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html Read more...} */ constructor(properties?: PointCloudBitfieldFilterProperties); static fromJSON(json: any): PointCloudBitfieldFilter; } interface PointCloudBitfieldFilterProperties extends PointCloudFilterProperties { /** * An array of bit positions where the bit value must be `0`, otherwise the point will not be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html#requiredClearBits Read more...} */ requiredClearBits?: number[] | nullish; /** * An array of bit positions where the bit value must be `1`, otherwise the point will not be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudBitfieldFilter.html#requiredSetBits Read more...} */ requiredSetBits?: number[] | nullish; } export interface PointCloudFilter extends Accessor, JSONSupport { } export class PointCloudFilter { /** * The field used for applying the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html#field Read more...} */ field: string | nullish; /** * The type of filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html#type Read more...} */ readonly type: "value" | "bitfield" | "return"; /** * Point cloud filters are used to hide points that do not satisfy the filter criteria. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html Read more...} */ constructor(properties?: PointCloudFilterProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PointCloudFilter; } interface PointCloudFilterProperties { /** * The field used for applying the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html#field Read more...} */ field?: string | nullish; } export class PointCloudReturnFilter extends PointCloudFilter { /** * An array of return types used to filter points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudReturnFilter.html#includedReturns Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudReturnFilter.html Read more...} */ constructor(properties?: PointCloudReturnFilterProperties); static fromJSON(json: any): PointCloudReturnFilter; } interface PointCloudReturnFilterProperties extends PointCloudFilterProperties { /** * An array of return types used to filter points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudReturnFilter.html#includedReturns Read more...} */ includedReturns?: ("firstOfMany" | "last" | "lastOfMany" | "single")[]; } export class PointCloudValueFilter extends PointCloudFilter { /** * Whether points should be included or excluded from the filter. * * @default "exclude" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudValueFilter.html#mode Read more...} */ mode: "include" | "exclude"; readonly type: "value"; /** * An array of numeric values representing the classification codes * that the filter should apply. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudValueFilter.html#values Read more...} */ values: number[]; /** * Every lidar point can have a classification that defines the type of surface that reflected * the laser pulse. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudValueFilter.html Read more...} */ constructor(properties?: PointCloudValueFilterProperties); static fromJSON(json: any): PointCloudValueFilter; } interface PointCloudValueFilterProperties extends PointCloudFilterProperties { /** * Whether points should be included or excluded from the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudValueFilter.html#mode Read more...} */ mode?: "include" | "exclude"; /** * An array of numeric values representing the classification codes * that the filter should apply. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudValueFilter.html#values Read more...} */ values?: number[]; } export interface PointCloudLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class PointCloudLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#copyright Read more...} */ declare copyright: SceneService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#layerId Read more...} */ declare layerId: SceneService["layerId"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when points in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; readonly type: "point-cloud"; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#url Read more...} */ declare url: SceneService["url"]; /** * The version of the scene service specification used for this service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#version Read more...} */ declare readonly version: SceneService["version"]; /** * The PointCloudLayer is designed for visualizing large collections of points * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html Read more...} */ constructor(properties?: PointCloudLayerProperties); /** * Specifies how points are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#elevationInfo Read more...} */ get elevationInfo(): PointCloudLayerElevationInfo | nullish; set elevationInfo(value: PointCloudLayerElevationInfoProperties | nullish); /** * An array of fields accessible in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html pointCloudFilters} used to filter points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#filters Read more...} */ get filters(): (PointCloudValueFilter | PointCloudReturnFilter | PointCloudBitfieldFilter)[]; set filters(value: ( | (PointCloudValueFilterProperties & { type: "value" }) | (PointCloudReturnFilterProperties & { type: "return" }) | (PointCloudBitfieldFilterProperties & { type: "bitfield" }) )[]); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#renderer Read more...} */ get renderer(): PointCloudRenderer | nullish; set renderer(value: PointCloudRendererProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string): Domain | nullish; /** * Queries cached statistics from the service for a given field. * * @param fieldName The name of the field to query statistics for. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#queryCachedStatistics Read more...} */ queryCachedStatistics(fieldName: string, options?: PointCloudLayerQueryCachedStatisticsOptions): any; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#save Read more...} */ save(): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options additional save options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: PointCloudLayerSaveAsOptions): Promise; static fromJSON(json: any): PointCloudLayer; } interface PointCloudLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#copyright Read more...} */ copyright?: SceneServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Specifies how points are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#elevationInfo Read more...} */ elevationInfo?: PointCloudLayerElevationInfoProperties | nullish; /** * An array of fields accessible in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-pointCloudFilters-PointCloudFilter.html pointCloudFilters} used to filter points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#filters Read more...} */ filters?: ( | (PointCloudValueFilterProperties & { type: "value" }) | (PointCloudReturnFilterProperties & { type: "return" }) | (PointCloudBitfieldFilterProperties & { type: "bitfield" }) )[]; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#layerId Read more...} */ layerId?: SceneServiceProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when points in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#renderer Read more...} */ renderer?: PointCloudRendererProperties | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#url Read more...} */ url?: SceneServiceProperties["url"]; } export interface PointCloudLayerElevationInfoProperties { mode?: "absolute-height"; offset?: number | nullish; unit?: ElevationUnit | nullish; } export interface PointCloudLayerElevationInfo extends AnonymousAccessor { mode: "absolute-height"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface PointCloudLayerQueryCachedStatisticsOptions { signal?: AbortSignal | nullish; } export interface PointCloudLayerSaveAsOptions { folder?: PortalFolder; } export interface RouteLayer extends Layer, BlendLayer, OperationalLayer, PortalLayer, ScaleRangeLayer { } export class RouteLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html DirectionLine} that represent the linear path between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionPoints directionPoints} of the * solved route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionLines Read more...} */ readonly directionLines: Collection | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html DirectionPoint} that represent the turn-by-turn directions along * a solved route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionPoints Read more...} */ readonly directionPoints: Collection | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * This property contains the solved route's geometry and other route information like overall time and distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#routeInfo Read more...} */ readonly routeInfo: RouteInfo | nullish; readonly type: "route"; /** * The URL of the REST endpoint of the Route service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#url Read more...} */ url: string; /** * RouteLayer is a layer for visualizing and solving routes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html Read more...} */ constructor(properties?: RouteLayerProperties); /** * The default symbol used for new stops and route results generated by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#solve solve()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#defaultSymbols Read more...} */ get defaultSymbols(): RouteSymbols; set defaultSymbols(value: RouteSymbolsProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html PointBarrier} are used to prevent navigation through the street * network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers Read more...} */ get pointBarriers(): Collection; set pointBarriers(value: CollectionProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html PolygonBarrier} are used to prevent navigation through the * street network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers Read more...} */ get polygonBarriers(): Collection; set polygonBarriers(value: CollectionProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html PolylineBarrier} are used to prevent navigation through the * street network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers Read more...} */ get polylineBarriers(): Collection; set polylineBarriers(value: CollectionProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html Stop}s define the start, end, waypoint, or break of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops Read more...} */ get stops(): Collection; set stops(value: CollectionProperties); /** * Update the currently assigned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} using information in this RouteLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#save Read more...} */ save(): Promise; /** * Saves the route layer to a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * @param portalItem The new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} to which the layer will be saved. * @param options Save options. Currently, there is only one property that can be set, which is `folder`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: RouteLayerSaveAsOptions): Promise; /** * This method will solve the route using the route service referenced by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#routeServiceUrl routeServiceUrl} * and the network objects {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers pointBarriers}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers polylineBarriers}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers polygonBarriers}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * @param routeParameters * The following properties are preset and cannot be overridden: * * Property | Value * --------------------------------|---------------- * directionsOutputType | "featuresets" * ignoreInvalidLocations | `true` * preserveObjectID | `true` * returnBarriers | `true` * returnDirections | `true` * returnPolygonBarriers | `true` * returnPolylineBarriers | `true` * returnRoutes | `true` * returnStops | `true` * * The following properties will also be set automatically, but can be overridden: * * | Property | Default Value | * |---------------------------------|-----------------------------------------------| * | pointBarriers | Same as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers pointBarriers} | * | polylineBarriers | Same as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers polylineBarriers} | * | polygonBarriers | Same as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers polygonBarriers} | * | stops | Same as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops} | * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#solve Read more...} */ solve(routeParameters: RouteParameters, requestOptions?: RequestOptions): Promise; /** * Updates the layer with the results from a solved route layer. * * @param routeLayerSolveResult See the table below for details of each parameter that may be passed to this method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#update Read more...} */ update(routeLayerSolveResult: RouteLayerUpdateRouteLayerSolveResult): void; static fromJSON(json: any): RouteLayer; } interface RouteLayerProperties extends LayerProperties, BlendLayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The default symbol used for new stops and route results generated by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#solve solve()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#defaultSymbols Read more...} */ defaultSymbols?: RouteSymbolsProperties; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html PointBarrier} are used to prevent navigation through the street * network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers Read more...} */ pointBarriers?: CollectionProperties; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html PolygonBarrier} are used to prevent navigation through the * street network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers Read more...} */ polygonBarriers?: CollectionProperties; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html PolylineBarrier} are used to prevent navigation through the * street network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers Read more...} */ polylineBarriers?: CollectionProperties; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html Stop}s define the start, end, waypoint, or break of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops Read more...} */ stops?: CollectionProperties; /** * The URL of the REST endpoint of the Route service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#url Read more...} */ url?: string; } export interface RouteLayerSaveAsOptions { folder?: PortalFolder; } /** * The results of computing a route and directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#RouteLayerSolveResult Read more...} */ export interface RouteLayerSolveResult { directionLines: Collection; directionPoints: Collection; pointBarriers?: Collection; polygonBarriers?: Collection; polylineBarriers?: Collection; routeInfo: RouteInfo; stops: Collection; } export interface RouteLayerUpdateRouteLayerSolveResult { directionLines: Collection; directionPoints: Collection; pointBarriers: Collection; polygonBarriers: Collection; polylineBarriers: Collection; routeInfo: RouteInfo; stops: Collection; } export interface SceneLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, TemporalSceneLayer, CustomParametersMixin, APIKeyMixin, Clonable { } export class SceneLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#capabilities Read more...} */ readonly capabilities: SceneLayerCapabilities; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#copyright Read more...} */ declare copyright: SceneService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The SQL where clause used to filter features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#effectiveCapabilities Read more...} */ readonly effectiveCapabilities: SceneLayerCapabilities; /** * An array of fields accessible in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#fields Read more...} */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#geometryType Read more...} */ geometryType: "point" | "mesh"; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#layerId Read more...} */ declare layerId: SceneService["layerId"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of the field containing each graphic's Object ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#objectIdField Read more...} */ objectIdField: string; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} set up for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#relationships Read more...} */ readonly relationships: Relationship[] | nullish; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; readonly type: "scene"; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#url Read more...} */ declare url: SceneService["url"]; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#useViewTime Read more...} */ useViewTime: boolean; /** * The version of the scene service specification used for this service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#version Read more...} */ declare readonly version: SceneService["version"]; /** * The SceneLayer is a layer type designed for on-demand streaming and displaying large * amounts of data in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html Read more...} */ constructor(properties?: SceneLayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#elevationInfo Read more...} */ get elevationInfo(): SceneLayerElevationInfo | nullish; set elevationInfo(value: SceneLayerElevationInfoProperties | nullish); /** * List of ObjectIDs not being displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#excludeObjectIds Read more...} */ get excludeObjectIds(): Collection; set excludeObjectIds(value: CollectionProperties); /** * Configures the method for decluttering overlapping features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionSelection | nullish; set featureReduction(value: (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * A collection of polygons {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#geometries geometries} which will mask out different parts of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#filter Read more...} */ get filter(): SceneFilter | nullish; set filter(value: SceneFilterProperties | nullish); /** * When a scene layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#floorInfo Read more...} */ get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#renderer Read more...} */ get renderer(): RendererUnion; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Applies edits to the features in the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * @param edits Object containing features to be updated. * @param options Additional edit options to specify when editing features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#applyEdits Read more...} */ applyEdits(edits: SceneLayerApplyEditsEdits, options?: SceneLayerApplyEditsOptions): Promise; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#clone Read more...} */ clone(): this; /** * Converts a file or list of files to mesh geometry. * * @param files The files from which to create the mesh. * @param options Options to configure the conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#convertMesh Read more...} */ convertMesh(files: File[], options?: ConvertMeshOptions): Promise; /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates a query object that can be used to fetch features that * satisfy the layer's current definition expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: SceneLayerGetFieldDomainOptions): Domain | nullish; /** * Gets field usage information. * * @param fieldName The name of the field to get usage info for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#getFieldUsageInfo Read more...} */ getFieldUsageInfo(fieldName: string): any; /** * Query information about attachments associated with features. * * @param attachmentQuery Specifies the attachment parameters for query. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryAttachments Read more...} */ queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: SceneLayerQueryAttachmentsOptions): Promise; /** * Queries cached statistics from the service for a given field. * * @param fieldName The name of the field to query statistics for. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryCachedStatistics Read more...} */ queryCachedStatistics(fieldName: string | nullish, options?: SceneLayerQueryCachedStatisticsOptions): any; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns the 2D * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: SceneLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns the number of * features that satisfy the query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: SceneLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: SceneLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the associated feature service and returns an array of * ObjectIDs of the features that satisfy the input query. * * @param query Specifies the query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: SceneLayerQueryObjectIdsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service * associated with the scene layer and returns * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSets} grouped by source layer or table objectIds. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryRelatedFeatures Read more...} */ queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: SceneLayerQueryRelatedFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service associated * with the scene layer and when resolved, it returns an `object` containing key value pairs. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#queryRelatedFeaturesCount Read more...} */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: SceneLayerQueryRelatedFeaturesCountOptions): Promise; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#save Read more...} */ save(): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options additional save options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: SceneLayerSaveAsOptions): 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, TemporalSceneLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#copyright Read more...} */ copyright?: SceneServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The SQL where clause used to filter features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#elevationInfo Read more...} */ elevationInfo?: SceneLayerElevationInfoProperties | nullish; /** * List of ObjectIDs not being displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#excludeObjectIds Read more...} */ excludeObjectIds?: CollectionProperties; /** * Configures the method for decluttering overlapping features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#featureReduction Read more...} */ featureReduction?: (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * A collection of polygons {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#geometries geometries} which will mask out different parts of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#filter Read more...} */ filter?: SceneFilterProperties | nullish; /** * When a scene layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#floorInfo Read more...} */ floorInfo?: LayerFloorInfoProperties | nullish; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#geometryType Read more...} */ geometryType?: "point" | "mesh"; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#layerId Read more...} */ layerId?: SceneServiceProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of the field containing each graphic's Object ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }); /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#url Read more...} */ url?: SceneServiceProperties["url"]; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#useViewTime Read more...} */ useViewTime?: boolean; } /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#Capabilities Read more...} */ export interface SceneLayerCapabilities { query: SceneLayerCapabilitiesQuery; queryRelated: SceneLayerCapabilitiesQueryRelated; data: SceneLayerCapabilitiesData; editing: SceneLayerCapabilitiesEditing; operations: SceneLayerCapabilitiesOperations; } /** * Options used to configure mesh conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#ConvertMeshOptions Read more...} */ export interface ConvertMeshOptions { location?: Point; signal?: AbortSignal | nullish; } export interface SceneLayerEditsEvent { addedFeatures: FeatureEditResult[]; deletedFeatures: FeatureEditResult[]; exceededTransferLimit: boolean; updatedFeatures: FeatureEditResult[]; } /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#applyEdits applyEdits} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#EditsResult Read more...} */ export interface SceneLayerEditsResult { addFeatureResults: FeatureEditResult[]; updateFeatureResults: FeatureEditResult[]; deleteFeatureResults: FeatureEditResult[]; } /** * Alternative representation of features to be deleted with applyEdits. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#FeatureIdentifier Read more...} */ export interface SceneLayerFeatureIdentifier { objectId: number | nullish; globalId: string | nullish; } export interface SceneLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface SceneLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface SceneLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface SceneLayerApplyEditsEdits { addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | SceneLayerFeatureIdentifier[]; } export interface SceneLayerApplyEditsOptions { rollbackOnFailureEnabled?: boolean; globalIdUsed?: boolean; } export interface SceneLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; unit?: ElevationUnit | nullish; } export interface SceneLayerElevationInfo extends AnonymousAccessor { mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface SceneLayerGetFieldDomainOptions { feature: Graphic; } export interface SceneLayerQueryAttachmentsOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryCachedStatisticsOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryRelatedFeaturesCountOptions { signal?: AbortSignal | nullish; } export interface SceneLayerQueryRelatedFeaturesOptions { signal?: AbortSignal | nullish; } export interface SceneLayerSaveAsOptions { folder?: PortalFolder; } export interface SceneLayerCapabilitiesData { supportsZ: boolean; supportsAttachment: boolean; } export interface SceneLayerCapabilitiesEditing { supportsGeometryUpdate: boolean; supportsGlobalId: boolean; supportsRollbackOnFailure: boolean; } export interface SceneLayerCapabilitiesOperations { supportsAdd: boolean; supportsDelete: boolean; supportsUpdate: boolean; supportsEditing: boolean; supportsQuery: boolean; supportsQueryAttachments: boolean; } export interface SceneLayerCapabilitiesQuery { maxRecordCount: number | nullish; supportsCentroid: boolean; supportsDistance: boolean; supportsDistinct: boolean; supportsDisjointSpatialRelationship: boolean; supportsCacheHint: boolean; supportsExtent: boolean; supportsGeometryProperties: boolean; supportsHavingClause: boolean; supportsOrderBy: boolean; supportsPagination: boolean; supportsPercentileStatistics: boolean; supportsQueryGeometry: boolean; supportsQuantization: boolean; supportsQuantizationEditMode: boolean; supportsResultType: boolean; supportsReturnMesh: boolean; supportsSqlExpression: boolean; supportsStandardizedQueriesOnly: boolean; supportsStatistics: boolean; supportsHistoricMoment: boolean; supportsTrueCurve: boolean; } export interface SceneLayerCapabilitiesQueryRelated { supportsCacheHint: boolean; supportsCount: boolean; supportsOrderBy: boolean; supportsPagination: boolean; } export interface StreamLayer extends Layer, BlendLayer, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, ScaleRangeLayer, TemporalLayer, TrackableLayer, Clonable { } export class StreamLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#customParameters Read more...} */ customParameters: any; /** * The SQL where clause used to filter features based on their attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#geometryType Read more...} */ geometryType: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum number of attempts to reconnect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxReconnectionAttempts Read more...} */ maxReconnectionAttempts: number; /** * The maximum time to wait in seconds between attempts to reconnect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxReconnectionInterval Read more...} */ maxReconnectionInterval: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#objectIdField Read more...} */ objectIdField: string; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; /** * The [stream service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/stream-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#sourceJSON Read more...} */ sourceJSON: any; /** * For {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html StreamLayer} the type is `stream`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#type Read more...} */ readonly type: "stream"; /** * The minimum rate (ms) at which to poll for updates over the websocket connection. * * @default 300 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#updateInterval Read more...} */ updateInterval: number; /** * The URL of the stream service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#url Read more...} */ url: string; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The URL of a websocket connection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#webSocketUrl Read more...} */ webSocketUrl: string | nullish; /** * StreamLayer connects to a [stream service](https://enterprise.geosceneonline.cn/zh/geoevent) or * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#streamlayer-from-websocket custom WebSocket service}, * displaying the observation streams associated with a set of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#track-aware tracked objects} * in real-time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html Read more...} */ constructor(properties?: StreamLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#elevationInfo Read more...} */ get elevationInfo(): StreamLayerElevationInfo | nullish; set elevationInfo(value: StreamLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} object used to filter features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#geometryDefinition Read more...} */ get geometryDefinition(): Extent | nullish; set geometryDefinition(value: ExtentProperties | nullish); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Options for purging stale features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#purgeOptions Read more...} */ get purgeOptions(): StreamLayerPurgeOptions; set purgeOptions(value: StreamLayerPurgeOptionsProperties); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#clone Read more...} */ clone(): this; /** * Establishes a connection to a web socket that satisfy the specified connection parameters. * * @param parameters Specifies the connection parameters. If no parameters are specified, the connection will use the layer's configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#connect Read more...} */ connect(parameters?: ConnectionParameters): Promise; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#ConnectionParameters ConnectionParameters} object that can be used to establish a connection to a web socket that * satisfies the layer's configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#createConnectionParameters Read more...} */ createConnectionParameters(): ConnectionParameters; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: StreamLayerGetFieldDomainOptions): Domain | nullish; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#save Read more...} */ save(options?: StreamLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: StreamLayerSaveAsOptions): Promise; /** * Sends client-side only messages. * * @param message The message object to send to the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#sendMessageToClient Read more...} */ sendMessageToClient(message: any): void; /** * Sends a message over the websocket to the server. * * @param message The message object to be sent from the client to the server over the web socket. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#sendMessageToSocket Read more...} */ sendMessageToSocket(message: any): void; static fromJSON(json: any): StreamLayer; } interface StreamLayerProperties extends LayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, TrackableLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#customParameters Read more...} */ customParameters?: any; /** * The SQL where clause used to filter features based on their attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#elevationInfo Read more...} */ elevationInfo?: StreamLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} object used to filter features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#geometryDefinition Read more...} */ geometryDefinition?: ExtentProperties | nullish; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#geometryType Read more...} */ geometryType?: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum number of attempts to reconnect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxReconnectionAttempts Read more...} */ maxReconnectionAttempts?: number; /** * The maximum time to wait in seconds between attempts to reconnect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxReconnectionInterval Read more...} */ maxReconnectionInterval?: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * Options for purging stale features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#purgeOptions Read more...} */ purgeOptions?: StreamLayerPurgeOptionsProperties; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * The [stream service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/stream-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#sourceJSON Read more...} */ sourceJSON?: any; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The minimum rate (ms) at which to poll for updates over the websocket connection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#updateInterval Read more...} */ updateInterval?: number; /** * The URL of the stream service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#url Read more...} */ url?: string; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; /** * The URL of a websocket connection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#webSocketUrl Read more...} */ webSocketUrl?: string | nullish; } /** * The connection parameters that can be used to establish a connection to a web socket when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#connect connect()} method is called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html#ConnectionParameters Read more...} */ export interface ConnectionParameters { spatialReference?: SpatialReference; customParameters?: any; definitionExpression?: string | nullish; geometryDefinition?: Extent | nullish; maxReconnectionAttempts?: number; maxReconnectionInterval?: number; } export interface StreamLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: StreamLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface StreamLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): StreamLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: StreamLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface StreamLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface StreamLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface StreamLayerGetFieldDomainOptions { feature: Graphic; } export interface StreamLayerPurgeOptionsProperties { age?: number | nullish; ageReceived?: number | nullish; displayCount?: number | nullish; maxObservations?: number | nullish; } export interface StreamLayerPurgeOptions extends AnonymousAccessor { age: number | nullish; ageReceived: number | nullish; displayCount: number | nullish; maxObservations: number | nullish; } export interface StreamLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface StreamLayerSaveOptions { ignoreUnsupported?: boolean; } export interface SubtypeGroupLayer extends Layer, BlendLayer, Clonable, CustomParametersMixin, DisplayFilteredLayer, FeatureLayerBase, OperationalLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, TemporalLayer { } export class SubtypeGroupLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#capabilities Read more...} */ declare readonly capabilities: FeatureLayerBase["capabilities"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#copyright Read more...} */ declare copyright: FeatureLayerBase["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#dateFieldsTimeZone Read more...} */ declare dateFieldsTimeZone: FeatureLayerBase["dateFieldsTimeZone"]; /** * This property is set by the service publisher and indicates that dates should be considered without the local timezone. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#datesInUnknownTimezone Read more...} */ declare readonly datesInUnknownTimezone: FeatureLayerBase["datesInUnknownTimezone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#definitionExpression Read more...} */ declare definitionExpression: FeatureLayerBase["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayField Read more...} */ declare displayField: FeatureLayerBase["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * The editor tracking fields, which record who adds or edits the data through the feature service * and when edits are made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#editFieldsInfo Read more...} */ declare readonly editFieldsInfo: FeatureLayerBase["editFieldsInfo"]; /** * Determines if the layer is editable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#editingEnabled Read more...} */ readonly editingEnabled: boolean; /** * Specifies information about editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#editingInfo Read more...} */ declare readonly editingInfo: FeatureLayerBase["editingInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#effectiveCapabilities Read more...} */ declare readonly effectiveCapabilities: FeatureLayerBase["effectiveCapabilities"]; /** * Indicates whether the layer is editable taking in to consideration privileges of the * currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#effectiveEditingEnabled Read more...} */ declare readonly effectiveEditingEnabled: FeatureLayerBase["effectiveEditingEnabled"]; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fields Read more...} */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fieldsIndex Read more...} */ declare readonly fieldsIndex: FeatureLayerBase["fieldsIndex"]; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#gdbVersion Read more...} */ declare gdbVersion: FeatureLayerBase["gdbVersion"]; /** * Provides information on the system maintained area and length fields along with their respective units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#geometryFieldsInfo Read more...} */ declare readonly geometryFieldsInfo: FeatureLayerBase["geometryFieldsInfo"]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#geometryType Read more...} */ declare geometryType: FeatureLayerBase["geometryType"]; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#globalIdField Read more...} */ declare globalIdField: FeatureLayerBase["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#hasM Read more...} */ declare hasM: FeatureLayerBase["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#hasZ Read more...} */ declare hasZ: FeatureLayerBase["hasZ"]; /** * Returns `true` if the layer is loaded from a non-spatial table in a service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#isTable Read more...} */ declare readonly isTable: FeatureLayerBase["isTable"]; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#layerId Read more...} */ declare layerId: FeatureLayerBase["layerId"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#objectIdField Read more...} */ declare objectIdField: FeatureLayerBase["objectIdField"]; /** * An array of field names from the service to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The IANA time zone the author of the service intended data from date fields to be viewed in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#preferredTimeZone Read more...} */ declare readonly preferredTimeZone: FeatureLayerBase["preferredTimeZone"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} set up for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#relationships Read more...} */ declare readonly relationships: FeatureLayerBase["relationships"]; /** * When `true`, indicates that M values will be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#returnM Read more...} */ declare returnM: FeatureLayerBase["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#returnZ Read more...} */ declare returnZ: FeatureLayerBase["returnZ"]; /** * The service definition expression limits the features available for display and query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#serviceDefinitionExpression Read more...} */ declare readonly serviceDefinitionExpression: FeatureLayerBase["serviceDefinitionExpression"]; /** * Indicates the portal item of the hosted feature service that contains this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#serviceItemId Read more...} */ declare readonly serviceItemId: FeatureLayerBase["serviceItemId"]; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#sourceJSON Read more...} */ declare sourceJSON: FeatureLayerBase["sourceJSON"]; /** * The name of the field which holds the id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#subtypes subtypes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#subtypeField Read more...} */ declare readonly subtypeField: FeatureLayerBase["subtypeField"]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html subtypes} defined in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#subtypes Read more...} */ declare readonly subtypes: FeatureLayerBase["subtypes"]; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#title Read more...} */ declare title: FeatureLayerBase["title"]; readonly type: "subtype-group"; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#url Read more...} */ declare url: FeatureLayerBase["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#useViewTime Read more...} */ declare useViewTime: TemporalLayer["useViewTime"]; /** * The version of GeoScene Server in which the layer is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#version Read more...} */ declare readonly version: FeatureLayerBase["version"]; /** * The SubtypeGroupLayer is a single layer that automatically creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html SubtypeSublayer} for * each subtype in its corresponding [feature service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-feature-service-.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html Read more...} */ constructor(properties?: SubtypeGroupLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#elevationInfo Read more...} */ get elevationInfo(): FeatureLayerBaseElevationInfo | nullish; set elevationInfo(value: FeatureLayerBaseElevationInfoProperties | nullish); /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#floorInfo Read more...} */ get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html SubtypeSublayer} objects that allow * you to alter the properties of one or more sublayers of the SubtypeGroupLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#sublayers Read more...} */ get sublayers(): Collection; set sublayers(value: CollectionProperties); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Adds an attachment to a feature. * * @param feature Feature to which the attachment is to be added. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#addAttachment Read more...} */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): Promise; /** * Applies edits to features in a layer. * * @param edits Object containing features and attachments to be added, updated or deleted. * @param options Additional edit options to specify when editing features or attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#applyEdits Read more...} */ applyEdits(edits: SubtypeGroupLayerApplyEditsEdits, options?: SubtypeGroupLayerApplyEditsOptions): Promise; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#clone Read more...} */ clone(): this; /** * Creates query parameter object that can be used to fetch features that * satisfy the layer's configurations such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#definitionExpression definitionExpression}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#gdbVersion gdbVersion}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#historicMoment historicMoment}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Deletes attachments from a feature. * * @param feature Feature containing attachments to be deleted. * @param attachmentIds Ids of the attachments to be deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#deleteAttachments Read more...} */ deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise; /** * Returns the sublayer to which the given feature belongs. * * @param feature The feature whose sublayer will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#findSublayerForFeature Read more...} */ findSublayerForFeature(feature: Graphic): SubtypeSublayer | nullish; /** * Returns the sublayer with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#subtypeCode subtypeCode} that matches the number passed as an argument. * * @param subtypeCode The subtype coded value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#findSublayerForSubtypeCode Read more...} */ findSublayerForSubtypeCode(subtypeCode: number): SubtypeSublayer | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: FeatureLayerBaseGetFieldDomainOptions): Domain | nullish; /** * Loads all of the sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#loadAll Read more...} */ loadAll(): Promise; /** * Query information about attachments associated with features. * * @param attachmentQuery Specifies the attachment parameters for query. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryAttachments Read more...} */ queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: SubtypeGroupLayerQueryAttachmentsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: SubtypeGroupLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: SubtypeGroupLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: SubtypeGroupLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: SubtypeGroupLayerQueryObjectIdsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSets} grouped by source layer or table objectIds. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryRelatedFeatures Read more...} */ queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: SubtypeGroupLayerQueryRelatedFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * when resolved, it returns an `object` containing key value pairs. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#queryRelatedFeaturesCount Read more...} */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: SubtypeGroupLayerQueryRelatedFeaturesCountOptions): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#refresh Read more...} */ refresh(): void; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#save Read more...} */ save(options?: SubtypeGroupLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: SubtypeGroupLayerSaveAsOptions): Promise; /** * Updates an existing attachment for a feature. * * @param feature The feature containing the attachment to be updated. * @param attachmentId Id of the attachment to be updated. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#updateAttachment Read more...} */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): 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, BlendLayerProperties, CustomParametersMixinProperties, DisplayFilteredLayerProperties, FeatureLayerBaseProperties, OperationalLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#copyright Read more...} */ copyright?: FeatureLayerBaseProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#dateFieldsTimeZone Read more...} */ dateFieldsTimeZone?: FeatureLayerBaseProperties["dateFieldsTimeZone"]; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#definitionExpression Read more...} */ definitionExpression?: FeatureLayerBaseProperties["definitionExpression"]; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayField Read more...} */ displayField?: FeatureLayerBaseProperties["displayField"]; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#elevationInfo Read more...} */ elevationInfo?: FeatureLayerBaseElevationInfoProperties | nullish; /** * When a feature layer is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#floorInfo Read more...} */ floorInfo?: LayerFloorInfoProperties | nullish; /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#gdbVersion Read more...} */ gdbVersion?: FeatureLayerBaseProperties["gdbVersion"]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#geometryType Read more...} */ geometryType?: FeatureLayerBaseProperties["geometryType"]; /** * The name of a `gid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#fields field} containing a globally unique identifier for each * feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#globalIdField Read more...} */ globalIdField?: FeatureLayerBaseProperties["globalIdField"]; /** * Indicates whether the client-side features in the layer have `M` (measurement) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#hasM Read more...} */ hasM?: FeatureLayerBaseProperties["hasM"]; /** * Indicates whether the client-side features in the layer have `Z` (elevation) values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#hasZ Read more...} */ hasZ?: FeatureLayerBaseProperties["hasZ"]; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The layer ID, or layer index, of a Feature Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#layerId Read more...} */ layerId?: FeatureLayerBaseProperties["layerId"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of the object id {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} containing a unique identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#objectIdField Read more...} */ objectIdField?: FeatureLayerBaseProperties["objectIdField"]; /** * An array of field names from the service to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * When `true`, indicates that M values will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#returnM Read more...} */ returnM?: FeatureLayerBaseProperties["returnM"]; /** * When `true`, indicates that z-values will always be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#returnZ Read more...} */ returnZ?: FeatureLayerBaseProperties["returnZ"]; /** * The [feature service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/layer-feature-service-.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#sourceJSON Read more...} */ sourceJSON?: FeatureLayerBaseProperties["sourceJSON"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html SubtypeSublayer} objects that allow * you to alter the properties of one or more sublayers of the SubtypeGroupLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#sublayers Read more...} */ sublayers?: CollectionProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#title Read more...} */ title?: FeatureLayerBaseProperties["title"]; /** * The absolute URL of the REST endpoint of the layer, non-spatial table or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#url Read more...} */ url?: FeatureLayerBaseProperties["url"]; /** * Determines if the time enabled layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html#useViewTime Read more...} */ useViewTime?: TemporalLayerProperties["useViewTime"]; } 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 SubtypeGroupLayerApplyEditsEdits { addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | any[]; addAttachments?: AttachmentEdit[]; updateAttachments?: AttachmentEdit[]; deleteAttachments?: string[]; } export interface SubtypeGroupLayerApplyEditsOptions { gdbVersion?: string; returnEditMoment?: boolean; returnServiceEditsOption?: "none" | "original-and-current-features"; rollbackOnFailureEnabled?: boolean; globalIdUsed?: boolean; } export interface SubtypeGroupLayerQueryAttachmentsOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryRelatedFeaturesCountOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerQueryRelatedFeaturesOptions { signal?: AbortSignal | nullish; } export interface SubtypeGroupLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface SubtypeGroupLayerSaveOptions { ignoreUnsupported?: boolean; } export interface AggregateField extends Accessor, JSONSupport { } export class AggregateField { /** * The display name that describes the aggregate field in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup}, and other UI elements. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#alias Read more...} */ alias: string | nullish; /** * Indicates whether the field was created internally by the JS API's rendering engine for * default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualizations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#isAutoGenerated Read more...} */ isAutoGenerated: boolean; /** * The name of the aggregate field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#name Read more...} */ name: string; /** * The name of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields layer field} to summarize with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#statisticType statisticType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticField Read more...} */ onStatisticField: string; /** * Defines the type of statistic used to aggregate data returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticField onStatisticField} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticExpression onStatisticExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#statisticType Read more...} */ statisticType: "avg" | "count" | "max" | "min" | "mode" | "sum" | "avg_angle"; /** * Defines the aggregate fields used in a layer visualized with * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html FeatureReductionBinning} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html Read more...} */ constructor(properties?: AggregateFieldProperties); /** * An object containing an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression, which evaluates for each child feature represented * by the aggregate graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticExpression Read more...} */ get onStatisticExpression(): supportExpressionInfo; set onStatisticExpression(value: supportExpressionInfoProperties); /** * Creates a deep clone of the AggregateField object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#clone Read more...} */ clone(): AggregateField; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AggregateField; } interface AggregateFieldProperties { /** * The display name that describes the aggregate field in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup}, and other UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#alias Read more...} */ alias?: string | nullish; /** * Indicates whether the field was created internally by the JS API's rendering engine for * default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#isAutoGenerated Read more...} */ isAutoGenerated?: boolean; /** * The name of the aggregate field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#name Read more...} */ name?: string; /** * An object containing an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression, which evaluates for each child feature represented * by the aggregate graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticExpression Read more...} */ onStatisticExpression?: supportExpressionInfoProperties; /** * The name of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields layer field} to summarize with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#statisticType statisticType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticField Read more...} */ onStatisticField?: string; /** * Defines the type of statistic used to aggregate data returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticField onStatisticField} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#onStatisticExpression onStatisticExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-AggregateField.html#statisticType Read more...} */ statisticType?: "avg" | "count" | "max" | "min" | "mode" | "sum" | "avg_angle"; } /** * Contains convenience methods for getting Arcade expressions defined on a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html Read more...} */ interface arcadeUtils { /** * Returns all Arcade expressions defined on a given layer and provides metadata describing the context for which each expression was authored. * * @param layer The layer from which to get all Arcade expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#getExpressionsFromLayer Read more...} */ getExpressionsFromLayer(layer: | CSVLayer | FeatureLayer | GeoJSONLayer | Sublayer | OGCFeatureLayer | SceneLayer | WFSLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer): arcadeUtilsExpressionInfo[]; } export const arcadeUtils: arcadeUtils; /** * Represents the result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#getExpressionsFromLayer getExpressionsFromLayer} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#ExpressionInfo Read more...} */ export interface arcadeUtilsExpressionInfo { expression: string; name?: string | nullish; title?: string | nullish; profileInfo: ExpressionInfoProfileInfo; } /** * Describes the context for which an Arcade expression was defined using the Feature Z profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#FeatureZProfileContext Read more...} */ export type FeatureZProfileContext = "order-by" | "elevation-info"; /** * Describes the context for which an Arcade expression was defined using the popup or popup element profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#PopupProfileContext Read more...} */ export type PopupProfileContext = "popup-template" | "popup-expression-content"; /** * Describes the context for which an Arcade expression was defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#ProfileContext Read more...} */ export type ProfileContext = | VisualizationProfileContext | PopupProfileContext | FeatureZProfileContext | "label-class" | "form-template" | "aggregate-field"; /** * Describes the context for which an Arcade expression was defined using the visualization profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-arcadeUtils.html#VisualizationProfileContext Read more...} */ 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 { name: | "aggregate-field" | "form-constraint" | "feature-z" | "field-calculation" | "form-calculation" | "labeling" | "popup" | "popup-element" | "popup-feature-reduction" | "popup-element-feature-reduction" | "visualization" | "popup-voxel" | "popup-element-voxel"; context: ProfileContext; source?: "layer" | "feature-reduction"; 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 GeoScene Pro. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#description Read more...} */ description: string | nullish; /** * Unique filter id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#id Read more...} */ readonly id: string; /** * Name of the filter for display in UIs, for example when the filter is edited in GeoScene Pro. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#name Read more...} */ name: string | nullish; /** * The `BuildingFilter` class defines a set of conditions that can be used to show or hide specific features of * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html Read more...} */ constructor(properties?: BuildingFilterProperties); /** * Filter blocks define which features should be visible in the affected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * and how the filtered features are drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#filterBlocks Read more...} */ get filterBlocks(): Collection | nullish; set filterBlocks(value: CollectionProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BuildingFilter; } interface BuildingFilterProperties { /** * Description of the filter for display in UIs, for example when the filter is edited in GeoScene Pro. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#description Read more...} */ description?: string | nullish; /** * Filter blocks define which features should be visible in the affected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * and how the filtered features are drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#filterBlocks Read more...} */ filterBlocks?: CollectionProperties | nullish; /** * Name of the filter for display in UIs, for example when the filter is edited in GeoScene Pro. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#name Read more...} */ name?: string | nullish; } /** * Object contained in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#filterBlocks filterBlocks} collection:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingFilter.html#BuildingFilterBlock Read more...} */ export interface BuildingFilterBlock { filterExpression: string | nullish; filterMode?: BuildingFilterBlockFilterMode; title?: string; } export interface BuildingFilterBlockFilterMode { type?: "solid" | "wire-frame" | "x-ray"; edges?: SolidEdges3D | SketchEdges3D | nullish; } export interface BuildingSummaryStatistics extends Accessor, Loadable, JSONSupport { } export class BuildingSummaryStatistics { /** * An array of statistics on all fields in all sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#fields Read more...} */ readonly fields: BuildingFieldStatistics[]; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * Contains statistics about the fields in all sublayers of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html Read more...} */ constructor(properties?: BuildingSummaryStatisticsProperties); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#cancelLoad Read more...} */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#toJSON Read more...} */ toJSON(): any; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BuildingSummaryStatistics; } interface BuildingSummaryStatisticsProperties extends LoadableProperties { } /** * Summary statistics for a field in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-BuildingSummaryStatistics.html#BuildingFieldStatistics Read more...} */ export interface BuildingFieldStatistics { fieldName: string; modelName: string; label: string; min: number; max: number; mostFrequentValues: string[] | number[]; subLayerIds: number[]; } export class CodedValueDomain extends Domain { /** * An array of the coded values in the domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html#codedValues Read more...} */ codedValues: CodedValue[]; readonly type: "coded-value"; /** * Information about the coded values belonging to the domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html Read more...} */ constructor(properties?: CodedValueDomainProperties); /** * Returns the name of the coded-value associated with the specified code. * * @param code The code associated with the desired name, e.g. `1` could be a code used for a returned name of `pavement`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html#getName Read more...} */ getName(code: string | number): string | nullish; static fromJSON(json: any): CodedValueDomain; } interface CodedValueDomainProperties extends DomainProperties { /** * An array of the coded values in the domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html#codedValues Read more...} */ codedValues?: CodedValue[]; } /** * The coded value in a domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html#CodedValue Read more...} */ export interface CodedValue { name: string; code: string | number; } export class ControlPointsGeoreference extends Accessor { /** * An array of two, three, or four {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints controlPoints} positions the media element. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints Read more...} */ controlPoints: ControlPoint[] | nullish; /** * Defines the size of the element displayed, typically the element's height in pixels. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#height Read more...} */ height: number; type: "control-points"; /** * Defines the size of the element displayed, typically the element's width in pixels. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#width Read more...} */ width: number; /** * ControlPointsGeoreference is used to set the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference geographic location} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html ImageElement} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html VideoElement} referenced * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints controlPoints}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#width width}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#height height} parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html Read more...} */ constructor(properties?: ControlPointsGeoreferenceProperties); /** * Converts the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#SourcePoint sourcePoint} to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html mapPoint}. * * @param sourcePoint The location on the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#toMap Read more...} */ toMap(sourcePoint: SourcePoint | nullish): Point | nullish; /** * Converts the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html mapPoint} to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#SourcePoint sourcePoint}. * * @param point A point geometry. In the case where the point is not in the same spatial reference as the one in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html mapPoint} of the first control point, it will be reprojected. {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-projection.html Projection engine} would need to be loaded to perform the reprojection, otherwise `null` is returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#toSource Read more...} */ toSource(point: Point): SourcePoint | nullish; } interface ControlPointsGeoreferenceProperties { /** * An array of two, three, or four {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints controlPoints} positions the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints Read more...} */ controlPoints?: ControlPoint[] | nullish; /** * Defines the size of the element displayed, typically the element's height in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#height Read more...} */ height?: number; type?: "control-points"; /** * Defines the size of the element displayed, typically the element's width in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#width Read more...} */ width?: number; } /** * A control point object in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#controlPoints controlPoints} array. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#ControlPoint Read more...} */ export interface ControlPoint { sourcePoint?: SourcePoint | nullish; mapPoint?: Point | nullish; } /** * An object representing a point on the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ControlPointsGeoreference.html#SourcePoint Read more...} */ export interface SourcePoint { x: number; y: number; } export class CornersGeoreference extends Accessor { /** * The georeference type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#type Read more...} */ readonly type: "corners"; /** * CornersGeoreference is used to set the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference geographic location} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html image} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html element} referenced * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} using corner points of a bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html Read more...} */ constructor(properties?: CornersGeoreferenceProperties); /** * The bottom left {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#bottomLeft Read more...} */ get bottomLeft(): Point | nullish; set bottomLeft(value: PointProperties | nullish); /** * The bottom right {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#bottomRight Read more...} */ get bottomRight(): Point | nullish; set bottomRight(value: PointProperties | nullish); /** * The top left {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#topLeft Read more...} */ get topLeft(): Point | nullish; set topLeft(value: PointProperties | nullish); /** * The top right {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#topRight Read more...} */ get topRight(): Point | nullish; set topRight(value: PointProperties | nullish); } interface CornersGeoreferenceProperties { /** * The bottom left {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#bottomLeft Read more...} */ bottomLeft?: PointProperties | nullish; /** * The bottom right {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#bottomRight Read more...} */ bottomRight?: PointProperties | nullish; /** * The top left {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#topLeft Read more...} */ topLeft?: PointProperties | nullish; /** * The top right {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} of the bounding box representing the geographic location of the image or video element being added * to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CornersGeoreference.html#topRight Read more...} */ topRight?: PointProperties | nullish; } /** * Provides utility functions for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-csvUtils.html Read more...} */ interface csvUtils { /** * Retrieves information about a CSV layer from a given URL. * * @param url The URL of the CSV file. * @param options An object specifying additional options. See the object specification table below for the properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-csvUtils.html#getCSVLayerInfo Read more...} */ getCSVLayerInfo(url: string, options?: csvUtilsGetCSVLayerInfoOptions): Promise; } export const csvUtils: csvUtils; /** * The layer info inferred from the CSV file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-csvUtils.html#CSVLayerInfo Read more...} */ export interface CSVLayerInfo { url: string; fields: Field[]; delimiter: string; latitudeField?: string | undefined; longitudeField?: string | undefined; customParameters?: any | nullish; } export interface csvUtilsGetCSVLayerInfoOptions { customParameters?: any; signal?: AbortSignal | nullish; } export interface DimensionalDefinition extends Accessor, JSONSupport { } export class DimensionalDefinition { /** * The dimension associated with the variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#dimensionName Read more...} */ dimensionName: string; /** * Indicates whether the values indicate slices (rather than ranges). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#isSlice Read more...} */ isSlice: boolean; /** * An array of single values or tuples [min, max] each defining a range of * valid values along the specified dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#values Read more...} */ values: (number | number[])[]; /** * The required variable name by which to filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#variableName Read more...} */ variableName: string; /** * A dimensional definition defines a filter based on one variable and one dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html Read more...} */ constructor(properties?: DimensionalDefinitionProperties); /** * Creates a clone of the DimensionalDefinition object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#clone Read more...} */ clone(): DimensionalDefinition; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DimensionalDefinition; } interface DimensionalDefinitionProperties { /** * The dimension associated with the variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#dimensionName Read more...} */ dimensionName?: string; /** * Indicates whether the values indicate slices (rather than ranges). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#isSlice Read more...} */ isSlice?: boolean; /** * An array of single values or tuples [min, max] each defining a range of * valid values along the specified dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#values Read more...} */ values?: (number | number[])[]; /** * The required variable name by which to filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DimensionalDefinition.html#variableName Read more...} */ variableName?: string; } export interface DisplayFilter extends Accessor, Clonable, JSONSupport { } export class DisplayFilter { /** * The display filter identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#id Read more...} */ id: string; /** * The maximum scale associated with the display filter. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale associated with the display filter. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#minScale Read more...} */ minScale: number; /** * A descriptive name or label that helps users identify and understand the purpose of the filter. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#title Read more...} */ title: string; /** * SQL-based where clause that filters the data to be rendered for display purposes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#where Read more...} */ where: string | nullish; /** * Display filters limit which features of a layer are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html Read more...} */ constructor(properties?: DisplayFilterProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DisplayFilter; } interface DisplayFilterProperties { /** * The display filter identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#id Read more...} */ id?: string; /** * The maximum scale associated with the display filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale associated with the display filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#minScale Read more...} */ minScale?: number; /** * A descriptive name or label that helps users identify and understand the purpose of the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#title Read more...} */ title?: string; /** * SQL-based where clause that filters the data to be rendered for display purposes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html#where Read more...} */ where?: string | nullish; } export interface DisplayFilterInfo extends Accessor, JSONSupport, Clonable { } export class DisplayFilterInfo { /** * The active filter id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#activeFilterId Read more...} */ activeFilterId: string | nullish; /** * The display filter mode. * * @default "manual" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#mode Read more...} */ mode: "manual" | "scale"; /** * Display filters are associated with a given layer and control which features are visible on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html Read more...} */ constructor(properties?: DisplayFilterInfoProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html filters} that define which features should be rendered on the display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#filters Read more...} */ get filters(): Collection; set filters(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DisplayFilterInfo; } interface DisplayFilterInfoProperties { /** * The active filter id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#activeFilterId Read more...} */ activeFilterId?: string | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilter.html filters} that define which features should be rendered on the display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#filters Read more...} */ filters?: CollectionProperties; /** * The display filter mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-DisplayFilterInfo.html#mode Read more...} */ mode?: "manual" | "scale"; } export interface Domain extends Accessor, JSONSupport { } export class Domain { /** * The domain name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#name Read more...} */ name: string; /** * The domain type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#type Read more...} */ type: "range" | "coded-value" | "inherited" | nullish; /** * Domains define constraints on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Read more...} */ constructor(properties?: DomainProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Domain; } interface DomainProperties { /** * The domain name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#name Read more...} */ name?: string; /** * The domain type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html#type Read more...} */ type?: "range" | "coded-value" | "inherited" | nullish; } export class ElevationSampler { /** * The minimum and maximum resolution of the data in the sampler. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#demResolution Read more...} */ readonly demResolution: ElevationSamplerDemResolution; /** * The extent within which the sampler can be queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#extent Read more...} */ readonly extent: Extent | nullish; /** * The value that is used to represent areas where there is no data available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#noDataValue Read more...} */ readonly noDataValue: number | nullish; /** * The spatial reference of the sampler. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; /** * Get elevation for a coordinate specified in the spatial reference of the sampler. * * @param x The x coordinate. * @param y The y coordinate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#elevationAt Read more...} */ elevationAt(x: number, y: number): number | nullish; /** * Query elevation for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html Multipoint} geometry. * * @param geometry The geometry to use for sampling elevation data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ElevationSampler.html#queryElevation Read more...} */ queryElevation(geometry: Point | Multipoint | Polyline): Point | Multipoint | Polyline | nullish; on(name: "changed", eventHandler: ElevationSamplerChangedEventHandler): IHandle; } export interface ElevationSamplerChangedEvent { } export interface ElevationSamplerDemResolution { min: number; max: number; } export interface supportExpressionInfo extends Accessor, JSONSupport, Clonable { } export class supportExpressionInfo { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#expression Read more...} */ expression: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#returnType Read more...} */ returnType: "string" | "number"; /** * The title used to describe the value returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#title Read more...} */ title: string | nullish; /** * The `ExpressionInfo` class references an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html Read more...} */ constructor(properties?: supportExpressionInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): supportExpressionInfo; } interface supportExpressionInfoProperties { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#expression Read more...} */ expression?: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#returnType Read more...} */ returnType?: "string" | "number"; /** * The title used to describe the value returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExpressionInfo.html#title Read more...} */ title?: string | nullish; } export class ExtentAndRotationGeoreference extends Accessor { /** * A rotation of the image or video element when added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#rotation Read more...} */ rotation: number; /** * The georeference type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#type Read more...} */ readonly type: "extent-and-rotation"; /** * ExtentAndRotationGeoreference is used to set the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference geographic location} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html image} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html element} referenced * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#extent extent} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#rotation rotation} parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html Read more...} */ constructor(properties?: ExtentAndRotationGeoreferenceProperties); /** * An extent of the image or video element representing its geographic location when added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); } interface ExtentAndRotationGeoreferenceProperties { /** * An extent of the image or video element representing its geographic location when added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * A rotation of the image or video element when added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ExtentAndRotationGeoreference.html#rotation Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#facilityIdField Read more...} */ facilityIdField: string | nullish; /** * Identifies an operational layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#layerId Read more...} */ layerId: string | nullish; /** * The field name from the layer that defines the facility name for a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#nameField Read more...} */ nameField: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#siteIdField Read more...} */ siteIdField: string | nullish; /** * This value references the numeric ID of the sublayer if the Facility layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#sublayerId Read more...} */ sublayerId: number | nullish; /** * The FacilityLayerInfo describes the footprints of managed buildings and other structures. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html Read more...} */ constructor(properties?: FacilityLayerInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FacilityLayerInfo; } interface FacilityLayerInfoProperties { /** * The field name from the layer that defines the facility unique ID for a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#facilityIdField Read more...} */ facilityIdField?: string | nullish; /** * Identifies an operational layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#layerId Read more...} */ layerId?: string | nullish; /** * The field name from the layer that defines the facility name for a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#nameField Read more...} */ nameField?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#siteIdField Read more...} */ siteIdField?: string | nullish; /** * This value references the numeric ID of the sublayer if the Facility layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FacilityLayerInfo.html#sublayerId Read more...} */ sublayerId?: number | nullish; } export interface FeatureEffect extends Accessor, JSONSupport { } export class FeatureEffect { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#Effect effect} applied to features that do not meet * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter} requirements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedEffect Read more...} */ excludedEffect: Effect | nullish; /** * Indicates if labels are visible for features that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedEffect excluded} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedLabelsVisible Read more...} */ excludedLabelsVisible: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#Effect effect} applied to features that meet the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter} requirements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#includedEffect Read more...} */ includedEffect: Effect | nullish; /** * FeatureEffect allows you to emphasize or deemphasize features that * satisfy a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter} in 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html Read more...} */ constructor(properties?: FeatureEffectProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html filter} that drives the effect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Creates a deep clone of FeatureEffect object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#clone Read more...} */ clone(): FeatureEffect; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureEffect; } interface FeatureEffectProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#Effect effect} applied to features that do not meet * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter} requirements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedEffect Read more...} */ excludedEffect?: Effect | nullish; /** * Indicates if labels are visible for features that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedEffect excluded} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#excludedLabelsVisible Read more...} */ excludedLabelsVisible?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html filter} that drives the effect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#Effect effect} applied to features that meet the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#filter filter} requirements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#includedEffect Read more...} */ includedEffect?: Effect | nullish; } /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureEffect.html#Effect Read more...} */ export type Effect = any[] | string; export interface FeatureFilter extends Accessor, JSONSupport { } export class FeatureFilter { /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry} in a spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#distance Read more...} */ distance: number | nullish; /** * An array of objectIds of the features to be filtered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#objectIds Read more...} */ objectIds: number[] | nullish; /** * For spatial filters, this parameter defines the spatial relationship to filter features in the layer view * against the filter {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}. * * @default "intersects" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#spatialRelationship Read more...} */ spatialRelationship: string; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#distance distance} is specified in a spatial filter. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#units Read more...} */ units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | nullish; /** * A where clause for the feature filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where Read more...} */ where: string | nullish; /** * This class defines parameters for setting a client-side filter on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureEffect featureEffect} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#filter layer view}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html Read more...} */ constructor(properties?: FeatureFilterProperties); /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * A range of time with start and end date. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Creates a deep clone of the FeatureFilter object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#clone Read more...} */ clone(): FeatureFilter; /** * Creates {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html query} parameters that can be used to fetch features that * satisfy the layer's current filters and definitions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#createQuery Read more...} */ createQuery(): Query; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureFilter; } interface FeatureFilterProperties { /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry} in a spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#distance Read more...} */ distance?: number | nullish; /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * An array of objectIds of the features to be filtered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#objectIds Read more...} */ objectIds?: number[] | nullish; /** * For spatial filters, this parameter defines the spatial relationship to filter features in the layer view * against the filter {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#spatialRelationship Read more...} */ spatialRelationship?: string; /** * A range of time with start and end date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#distance distance} is specified in a spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#units Read more...} */ units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | nullish; /** * A where clause for the feature filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where Read more...} */ where?: string | nullish; } export interface FeatureReductionBinning extends Accessor, JSONSupport { } export class FeatureReductionBinning { /** * The fixed geohash level used to create bins. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fixedBinLevel Read more...} */ fixedBinLevel: number | nullish; /** * Indicates whether to display labels for the bins. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Defines the maximum {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale view scale} at which binning is enabled. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#maxScale Read more...} */ maxScale: number; /** * Indicates whether to display a popup when a user clicks or touches a bin. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The feature reduction type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#type Read more...} */ type: "binning"; /** * Aggregates and summarizes dense features in a layer to bins in geographic space based on predefined [geohashes](https://en.wikipedia.org/wiki/Geohash). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html Read more...} */ constructor(properties?: FeatureReductionBinningProperties); /** * An array of aggregate fields that summarize layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields fields} * from features contained within each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fields Read more...} */ get fields(): AggregateField[]; set fields(value: AggregateFieldProperties[]); /** * Defines labels for bins as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer used to style the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * Creates a deep clone of the FeatureReductionBinning object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#clone Read more...} */ clone(): FeatureReductionBinning; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReductionBinning; } interface FeatureReductionBinningProperties { /** * An array of aggregate fields that summarize layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields fields} * from features contained within each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fields Read more...} */ fields?: AggregateFieldProperties[]; /** * The fixed geohash level used to create bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fixedBinLevel Read more...} */ fixedBinLevel?: number | nullish; /** * Defines labels for bins as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Defines the maximum {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale view scale} at which binning is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#maxScale Read more...} */ maxScale?: number; /** * Indicates whether to display a popup when a user clicks or touches a bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer used to style the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * The feature reduction type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#type Read more...} */ type?: "binning"; } export interface FeatureReductionCluster extends Accessor, JSONSupport { } export class FeatureReductionCluster { /** * Indicates whether to display labels for the clusters. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Defines the maximum {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale view scale} at which clustering is enabled. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#maxScale Read more...} */ maxScale: number; /** * Indicates whether to display the cluster popup. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The feature reduction type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#type Read more...} */ readonly type: "cluster"; /** * Aggregates and summarizes dense features in a layer to clusters defined in screen space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html Read more...} */ constructor(properties?: FeatureReductionClusterProperties); /** * Defines the symbol size of the largest cluster in points (or pixels if specified). * * @default 37.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterMaxSize Read more...} */ get clusterMaxSize(): number; set clusterMaxSize(value: number | string); /** * Defines the symbol size of the smallest cluster in points (or pixels if specified). * * @default 9 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterMinSize Read more...} */ get clusterMinSize(): number; set clusterMinSize(value: number | string); /** * Defines the radius in points (or pixels if specified) of the area in which multiple features will be grouped * and visualized as a single cluster. * * @default 60 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterRadius Read more...} */ get clusterRadius(): number; set clusterRadius(value: number | string); /** * An array of aggregate fields that summarize layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields fields} * from features contained within each cluster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#fields Read more...} */ get fields(): AggregateField[]; set fields(value: AggregateFieldProperties[]); /** * Defines labels for clusters as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to clustered graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer used to override the default style of the clusters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * A symbol used to override the default cluster style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#symbol Read more...} */ get symbol(): PictureMarkerSymbol | SimpleMarkerSymbol | TextSymbol | CIMSymbol | WebStyleSymbol | nullish; set symbol(value: | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * Creates a deep clone of the FeatureReductionCluster object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clone Read more...} */ clone(): FeatureReductionCluster; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReductionCluster; } interface FeatureReductionClusterProperties { /** * Defines the symbol size of the largest cluster in points (or pixels if specified). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterMaxSize Read more...} */ clusterMaxSize?: number | string; /** * Defines the symbol size of the smallest cluster in points (or pixels if specified). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterMinSize Read more...} */ clusterMinSize?: number | string; /** * Defines the radius in points (or pixels if specified) of the area in which multiple features will be grouped * and visualized as a single cluster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#clusterRadius Read more...} */ clusterRadius?: number | string; /** * An array of aggregate fields that summarize layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields fields} * from features contained within each cluster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#fields Read more...} */ fields?: AggregateFieldProperties[]; /** * Defines labels for clusters as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for the clusters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Defines the maximum {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale view scale} at which clustering is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#maxScale Read more...} */ maxScale?: number; /** * Indicates whether to display the cluster popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to clustered graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer used to override the default style of the clusters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * A symbol used to override the default cluster style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#symbol Read more...} */ symbol?: | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; } export interface FeatureReductionSelection extends Accessor, JSONSupport { } export class FeatureReductionSelection { /** * The feature reduction type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionSelection.html#type Read more...} */ type: "selection"; /** * Declutters points in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} by thinning overlapping features so no features * intersect on screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionSelection.html Read more...} */ constructor(properties?: FeatureReductionSelectionProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionSelection.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionSelection.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReductionSelection; } interface FeatureReductionSelectionProperties { /** * The feature reduction type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionSelection.html#type Read more...} */ type?: "selection"; } export interface FeatureTemplate extends Accessor, JSONSupport, Clonable { } export class FeatureTemplate { /** * Description of the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#description Read more...} */ description: string | nullish; /** * Name of the default drawing tool defined for the template to create a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#drawingTool Read more...} */ drawingTool: | "auto-complete-polygon" | "circle" | "ellipse" | "freehand" | "line" | "none" | "point" | "polygon" | "rectangle" | "arrow" | "triangle" | "left-arrow" | "right-arrow" | "up-arrow" | "down-arrow" | nullish; /** * Name of the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#name Read more...} */ name: string | nullish; /** * An instance of the prototypical feature described by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html feature template}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#prototype Read more...} */ prototype: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#thumbnail Read more...} */ thumbnail: FeatureTemplateThumbnail | nullish; /** * Feature templates define all the information required to create a new feature in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html Read more...} */ constructor(properties?: FeatureTemplateProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureTemplate; } interface FeatureTemplateProperties { /** * Description of the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#description Read more...} */ description?: string | nullish; /** * Name of the default drawing tool defined for the template to create a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#drawingTool Read more...} */ drawingTool?: | "auto-complete-polygon" | "circle" | "ellipse" | "freehand" | "line" | "none" | "point" | "polygon" | "rectangle" | "arrow" | "triangle" | "left-arrow" | "right-arrow" | "up-arrow" | "down-arrow" | nullish; /** * Name of the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#name Read more...} */ name?: string | nullish; /** * An instance of the prototypical feature described by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html feature template}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#prototype Read more...} */ prototype?: any; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html#thumbnail Read more...} */ thumbnail?: FeatureTemplateThumbnail | nullish; } export interface FeatureTemplateThumbnail { contentType: "image" | "png" | "jpg" | "jpeg"; imageData: string; height: number; width: number; } export interface FeatureType extends Accessor, JSONSupport, Clonable { } export class FeatureType { /** * Domains associated with the feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#domains Read more...} */ domains: HashMap; /** * The feature type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#id Read more...} */ id: number | string; /** * The feature type name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#name Read more...} */ name: string; /** * FeatureType is a subset of features defined in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} that share the same attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html Read more...} */ constructor(properties?: FeatureTypeProperties); /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html feature templates} associated with the feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#templates Read more...} */ get templates(): FeatureTemplate[]; set templates(value: FeatureTemplateProperties[]); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureType; } interface FeatureTypeProperties { /** * Domains associated with the feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#domains Read more...} */ domains?: HashMap; /** * The feature type identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#id Read more...} */ id?: number | string; /** * The feature type name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#name Read more...} */ name?: string; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html feature templates} associated with the feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html#templates Read more...} */ templates?: FeatureTemplateProperties[]; } export interface Field extends Accessor, JSONSupport { } export class Field { /** * The display name for the field. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#alias Read more...} */ alias: string | nullish; /** * The default value set for the field. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#defaultValue Read more...} */ defaultValue: number | string | nullish; /** * Contains information describing the purpose of each field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#description Read more...} */ description: string | nullish; /** * Indicates whether the field is editable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#editable Read more...} */ editable: boolean; /** * The field length. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#length Read more...} */ length: number | nullish; /** * The name of the field. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#name Read more...} */ name: string; /** * Indicates if the field can accept `null` values. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#nullable Read more...} */ nullable: boolean; /** * The data type of the field. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#valueType Read more...} */ 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" | nullish; /** * Information about each field in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Read more...} */ constructor(properties?: FieldProperties); /** * The domain associated with the field. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#domain Read more...} */ get domain(): CodedValueDomain | RangeDomain | InheritedDomain | nullish; set domain(value: | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | (InheritedDomainProperties & { type: "inherited" }) | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Field; } interface FieldProperties { /** * The display name for the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#alias Read more...} */ alias?: string | nullish; /** * The default value set for the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#defaultValue Read more...} */ defaultValue?: number | string | nullish; /** * Contains information describing the purpose of each field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#description Read more...} */ description?: string | nullish; /** * The domain associated with the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#domain Read more...} */ domain?: | (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }) | (InheritedDomainProperties & { type: "inherited" }) | nullish; /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#editable Read more...} */ editable?: boolean; /** * The field length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#length Read more...} */ length?: number | nullish; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#name Read more...} */ name?: string; /** * Indicates if the field can accept `null` values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#nullable Read more...} */ nullable?: boolean; /** * The data type of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#valueType Read more...} */ 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" | nullish; } export class FieldsIndex { /** * An array of date fields or field json objects. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldsIndex.html#dateFields Read more...} */ dateFields: Field[] | any[]; constructor(properties?: any); /** * Returns a field with the specified field name. * * @param fieldName The name of the field. The name is case-insensitive. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldsIndex.html#get Read more...} */ get(fieldName: string | nullish): Field | nullish; /** * Returns a [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for a field. * * @param fieldOrFieldName The name of the field or the field instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldsIndex.html#getTimeZone Read more...} */ getTimeZone(fieldOrFieldName: string | Field): string | nullish; /** * Checks if a field with the specified field name exists in the layer. * * @param fieldName The name of the field. The name is case-insensitive. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldsIndex.html#has Read more...} */ has(fieldName: string): boolean; /** * Checks if a field with the specified field name is a date field. * * @param fieldName The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FieldsIndex.html#isDateField Read more...} */ isDateField(fieldName: string | nullish): boolean; } /** * Convenience methods for getting field names used for feature layer * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelingInfo labeling}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#elevationInfo elevation}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#editFieldsInfo editor tracking} * and time span. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html Read more...} */ interface fieldUtils { /** * Gets the appropriate display field name to label a feature. * * @param layer An array of fields to determine the display field from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getDisplayFieldName Read more...} */ getDisplayFieldName(layer: FeatureLayer | CSVLayer | GeoJSONLayer | OGCFeatureLayer | SceneLayer | StreamLayer): string | nullish; /** * Returns an array of field names used in the Arcade expression for calculating the z-values of features * in the given feature layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#elevationInfo FeatureLayer.elevationInfo}. * * @param layer The featureLayer to extract fields required for calculating feature z-values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getElevationFields Read more...} */ getElevationFields(layer: FeatureLayer | nullish): Promise; /** * Returns an array of field names referenced in one or more {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions * to be set on the given layer in either the renderer, labels, or popup template. * * @param layer The layer for which the Arcade `expressions` are authored. This layer must have a `fields` property. * @param expressions An array of {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions to be set on the given `layer`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getExpressionFields Read more...} */ getExpressionFields(layer: FeatureLayer | CSVLayer | GeoJSONLayer | SceneLayer | StreamLayer, expressions: string[]): Promise; /** * Returns an array of editor tracking field names for a given layer. * * @param layer The layer from which to extract editor tracking fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getFeatureEditFields Read more...} */ getFeatureEditFields(layer: FeatureLayer | SubtypeGroupLayer): string[]; /** * Returns an array of geometry field names for a given layer. * * @param layer The layer to extract geometry fields from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getFeatureGeometryFields Read more...} */ getFeatureGeometryFields(layer: FeatureLayer | SubtypeGroupLayer): string[]; /** * Returns an array of field names used in the Arcade expression for labeling features * in the given feature layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#labelingInfo FeatureLayer.labelingInfo}. * * @param layer The Feature Layer from which to extract label fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getLabelingFields Read more...} */ getLabelingFields(layer: FeatureLayer | nullish): Promise; /** * Returns an array of field names used in the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer}. * * @param renderer Layer's renderer to collect field names used in that renderer. * @param fieldsIndex The field index of the layer. It can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getRendererFields Read more...} */ getRendererFields(renderer: RendererUnion | nullish, fieldsIndex: FieldsIndex): Promise; /** * Returns an array of field names related to time. * * @param layer The Feature Layer from which to extract time fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-fieldUtils.html#getTimeFields Read more...} */ getTimeFields(layer: FeatureLayer | nullish): 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html#shapeAreaField Read more...} */ readonly shapeAreaField: string | nullish; /** * The name of the field that stores the feature's length, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html#shapeLengthField Read more...} */ readonly shapeLengthField: string | nullish; /** * The units of measure for the area and length field values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html#units Read more...} */ readonly units: string | nullish; /** * The `GeometryFieldsInfo` class returns information about the system maintained geometry information associated with a specific feature in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html Read more...} */ constructor(properties?: GeometryFieldsInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-GeometryFieldsInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GeometryFieldsInfo; } interface GeometryFieldsInfoProperties { } export interface ImageElement extends Accessor, Loadable, MediaElementBase { } export class ImageElement { /** * The animation options for the image element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#animationOptions Read more...} */ animationOptions: AnimationOptions | nullish; /** * The image content referenced in the image element instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#content Read more...} */ readonly content: HTMLImageElement | HTMLCanvasElement | ImageData | nullish; /** * The image element to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source media layer's source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#image Read more...} */ image: string | HTMLImageElement | HTMLCanvasElement | ImageData | nullish; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The opacity of the element. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#opacity Read more...} */ declare opacity: MediaElementBase["opacity"]; /** * The element type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#type Read more...} */ readonly type: "image"; /** * Represents an image element referenced in the MediaLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html Read more...} */ constructor(properties?: ImageElementProperties); /** * The geographic location of the image or video element to be placed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference Read more...} */ get georeference(): ExtentAndRotationGeoreference | CornersGeoreference | ControlPointsGeoreference | nullish; set georeference(value: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#cancelLoad Read more...} */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface ImageElementProperties extends LoadableProperties, MediaElementBaseProperties { /** * The animation options for the image element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#animationOptions Read more...} */ animationOptions?: AnimationOptions | nullish; /** * The geographic location of the image or video element to be placed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#georeference Read more...} */ georeference?: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish; /** * The image element to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source media layer's source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#image Read more...} */ image?: string | HTMLImageElement | HTMLCanvasElement | ImageData | nullish; /** * The opacity of the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#opacity Read more...} */ opacity?: MediaElementBaseProperties["opacity"]; } /** * Represents animation options, a collection of properties that apply when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#image image} is an animated GIF or APNG. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html#AnimationOptions Read more...} */ export interface AnimationOptions { playing?: boolean; duration?: number; repeatType?: "none" | "loop" | "oscillate"; repeatDelay?: number; } export class InheritedDomain extends Domain { /** * The domain type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-InheritedDomain.html#type Read more...} */ readonly type: "inherited"; /** * This is a subclass of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-InheritedDomain.html Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#description Read more...} */ description: string | nullish; /** * The id for the KML sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#id Read more...} */ id: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html KMLLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#layer Read more...} */ layer: KMLLayer | nullish; /** * Network link info for the current layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#networkLink Read more...} */ readonly networkLink: any; /** * The parent layer to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#parent Read more...} */ parent: KMLSublayer | KMLLayer | nullish; /** * The raw KML data for this sublayer, in JSON format, as returned by the * [KML utility service](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#kmlServiceUrl). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#sourceJSON Read more...} */ sourceJSON: any; /** * The title of the KML sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#title Read more...} */ title: string | nullish; /** * Indicates if the sublayer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#visible Read more...} */ visible: boolean; /** * Represents a sublayer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html KMLLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html Read more...} */ constructor(properties?: KMLSublayerProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html KMLSublayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): KMLSublayer; } interface KMLSublayerProperties { /** * Description for the KML sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#description Read more...} */ description?: string | nullish; /** * The id for the KML sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#id Read more...} */ id?: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html KMLLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#layer Read more...} */ layer?: KMLLayer | nullish; /** * The parent layer to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#parent Read more...} */ parent?: KMLSublayer | KMLLayer | nullish; /** * The raw KML data for this sublayer, in JSON format, as returned by the * [KML utility service](https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#kmlServiceUrl). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#sourceJSON Read more...} */ sourceJSON?: any; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html KMLSublayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * The title of the KML sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#title Read more...} */ title?: string | nullish; /** * Indicates if the sublayer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-KMLSublayer.html#visible Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#allowOverrun Read more...} */ allowOverrun: boolean; /** * Defines how labels should be placed relative to one another. * * @default "static" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#deconflictionStrategy Read more...} */ deconflictionStrategy: "none" | "static"; /** * Defines the labels for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpression Read more...} */ labelExpression: string | nullish; /** * The position of the label. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelPlacement Read more...} */ 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 single line polyline label. * * @default "curved" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelPosition Read more...} */ labelPosition: "curved" | "parallel"; /** * The maximum scale (most zoomed in) at which labels are visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#minScale Read more...} */ minScale: number; /** * Indicates whether or not to repeat the label along the polyline feature. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#repeatLabel Read more...} */ repeatLabel: boolean; /** * Indicates whether to use domain names if the fields in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpression labelExpression} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpressionInfo labelExpressionInfo} have domains. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#useCodedValues Read more...} */ useCodedValues: boolean; /** * A SQL where clause used to determine the features to which the label class should be applied. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#where Read more...} */ where: string | nullish; /** * Defines label expressions, symbols, scale ranges, label priorities, and label placement options for labels on a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html Read more...} */ constructor(properties?: LabelClassProperties); /** * Defines the labels for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpressionInfo Read more...} */ get labelExpressionInfo(): LabelClassLabelExpressionInfo | nullish; set labelExpressionInfo(value: LabelClassLabelExpressionInfoProperties | nullish); /** * The size in points of the distance between labels on a polyline. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#repeatLabelDistance Read more...} */ get repeatLabelDistance(): number | nullish; set repeatLabelDistance(value: number | nullish | string); /** * Defines the symbol used for rendering the label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#symbol Read more...} */ get symbol(): TextSymbol | LabelSymbol3D; set symbol(value: (TextSymbolProperties & { type: "text" }) | (LabelSymbol3DProperties & { type: "label-3d" })); /** * Creates a deep clone of the LabelClass. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#clone Read more...} */ clone(): LabelClass; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LabelClass; } interface LabelClassProperties { /** * Specifies whether or not a polyline label can overrun the feature being labeled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#allowOverrun Read more...} */ allowOverrun?: boolean; /** * Defines how labels should be placed relative to one another. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#deconflictionStrategy Read more...} */ deconflictionStrategy?: "none" | "static"; /** * Defines the labels for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpression Read more...} */ labelExpression?: string | nullish; /** * Defines the labels for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpressionInfo Read more...} */ labelExpressionInfo?: LabelClassLabelExpressionInfoProperties | nullish; /** * The position of the label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelPlacement Read more...} */ 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 single line polyline label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelPosition Read more...} */ labelPosition?: "curved" | "parallel"; /** * The maximum scale (most zoomed in) at which labels are visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which labels are visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#minScale Read more...} */ minScale?: number; /** * Indicates whether or not to repeat the label along the polyline feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#repeatLabel Read more...} */ repeatLabel?: boolean; /** * The size in points of the distance between labels on a polyline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#repeatLabelDistance Read more...} */ repeatLabelDistance?: number | nullish | string; /** * Defines the symbol used for rendering the label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#symbol Read more...} */ symbol?: (TextSymbolProperties & { type: "text" }) | (LabelSymbol3DProperties & { type: "label-3d" }); /** * Indicates whether to use domain names if the fields in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpression labelExpression} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#labelExpressionInfo labelExpressionInfo} have domains. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#useCodedValues Read more...} */ useCodedValues?: boolean; /** * A SQL where clause used to determine the features to which the label class should be applied. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html#where Read more...} */ where?: string | nullish; } export interface LabelClassLabelExpressionInfoProperties { expression?: string | nullish; title?: string | nullish; } export interface LabelClassLabelExpressionInfo extends AnonymousAccessor { expression: string | nullish; title: string | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html#floorField Read more...} */ floorField: string; /** * LayerFloorInfo contains properties that allow a layer to be floor-aware. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html Read more...} */ constructor(properties?: LayerFloorInfoProperties); /** * Creates a deep clone of LayerFloorInfo object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html#clone Read more...} */ clone(): LayerFloorInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LayerFloorInfo; } interface LayerFloorInfoProperties { /** * The field name derived from a floor-aware layer and used to filter features by floor level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html#floorField Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#facilityIdField Read more...} */ facilityIdField: string | nullish; /** * The id for an operational layer in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#layerId Read more...} */ layerId: string | nullish; /** * The field name from the layer that defines a unique ID for the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#levelIdField Read more...} */ levelIdField: string | nullish; /** * The field name from the layer that defines the level floor number in a particular facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#levelNumberField Read more...} */ levelNumberField: string | nullish; /** * The field name from the layer that defines the level name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#longNameField Read more...} */ longNameField: string | nullish; /** * The field name from the layer that defines the level short name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#shortNameField Read more...} */ shortNameField: string | nullish; /** * This value references the numeric ID of the sublayer if the Level layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#sublayerId Read more...} */ sublayerId: number | nullish; /** * The field name from the layer that defines the order of display and reference to floors in the [Indoor Positioning System](https://doc.geoscene.cn/zh/indoors/android/configure-indoor-positioning.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#verticalOrderField Read more...} */ verticalOrderField: string | nullish; /** * The LevelLayerInfo class describes the footprint of each occupiable floor contained in a managed facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html Read more...} */ constructor(properties?: LevelLayerInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LevelLayerInfo; } interface LevelLayerInfoProperties { /** * The field name from the layer that defines the unique ID of a feature's associated facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#facilityIdField Read more...} */ facilityIdField?: string | nullish; /** * The id for an operational layer in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#layerId Read more...} */ layerId?: string | nullish; /** * The field name from the layer that defines a unique ID for the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#levelIdField Read more...} */ levelIdField?: string | nullish; /** * The field name from the layer that defines the level floor number in a particular facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#levelNumberField Read more...} */ levelNumberField?: string | nullish; /** * The field name from the layer that defines the level name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#longNameField Read more...} */ longNameField?: string | nullish; /** * The field name from the layer that defines the level short name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#shortNameField Read more...} */ shortNameField?: string | nullish; /** * This value references the numeric ID of the sublayer if the Level layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#sublayerId Read more...} */ sublayerId?: number | nullish; /** * The field name from the layer that defines the order of display and reference to floors in the [Indoor Positioning System](https://doc.geoscene.cn/zh/indoors/android/configure-indoor-positioning.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LevelLayerInfo.html#verticalOrderField Read more...} */ verticalOrderField?: string | nullish; } export class LocalMediaElementSource extends Accessor { /** * The LocalMediaElementSource is the default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source source} for the MediaLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LocalMediaElementSource.html Read more...} */ constructor(properties?: LocalMediaElementSourceProperties); /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html Image} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html video} * elements referenced in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LocalMediaElementSource.html#elements Read more...} */ get elements(): Collection; set elements(value: | CollectionProperties< (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) > | MediaElement[]); } interface LocalMediaElementSourceProperties { /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ImageElement.html Image} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html video} * elements referenced in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LocalMediaElementSource.html#elements Read more...} */ elements?: | CollectionProperties< (ImageElementProperties & { type: "image" }) | (VideoElementProperties & { type: "video" }) > | MediaElement[]; } /** * Image and video elements referenced in the MediaLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LocalMediaElementSource.html#MediaElement Read more...} */ export type MediaElement = ImageElement | VideoElement; export interface LOD extends Accessor, JSONSupport { } export class LOD { /** * ID for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#level Read more...} */ level: number; /** * String to be used when constructing a URL to access a tile from this LOD. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#levelValue Read more...} */ levelValue: string | nullish; /** * Resolution in map units of each pixel in a tile for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#resolution Read more...} */ resolution: number; /** * Scale for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#scale Read more...} */ scale: number; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html TileLayer} has a number of LODs (Levels of Detail). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html Read more...} */ constructor(properties?: LODProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LOD; } interface LODProperties { /** * ID for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#level Read more...} */ level?: number; /** * String to be used when constructing a URL to access a tile from this LOD. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#levelValue Read more...} */ levelValue?: string | nullish; /** * Resolution in map units of each pixel in a tile for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#resolution Read more...} */ resolution?: number; /** * Scale for each level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LOD.html#scale Read more...} */ scale?: number; } export interface MapImage extends Accessor, JSONSupport { } export class MapImage { /** * The requested image height in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#height Read more...} */ height: number | nullish; /** * URL to the returned image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#href Read more...} */ href: string | nullish; /** * The opacity of the image. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#opacity Read more...} */ opacity: number; /** * Scale of the requested dynamic map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#scale Read more...} */ scale: number | nullish; /** * Indicates if the requested image is visible in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#visible Read more...} */ visible: boolean; /** * The requested image width in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#width Read more...} */ width: number | nullish; /** * Represents the data object for the dynamically generated map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html Read more...} */ constructor(properties?: MapImageProperties); /** * The extent of the exported map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MapImage; } interface MapImageProperties { /** * The extent of the exported map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * The requested image height in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#height Read more...} */ height?: number | nullish; /** * URL to the returned image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#href Read more...} */ href?: string | nullish; /** * The opacity of the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#opacity Read more...} */ opacity?: number; /** * Scale of the requested dynamic map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#scale Read more...} */ scale?: number | nullish; /** * Indicates if the requested image is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#visible Read more...} */ visible?: boolean; /** * The requested image width in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MapImage.html#width Read more...} */ width?: number | nullish; } export class MediaElementBase { opacity: number; get georeference(): ExtentAndRotationGeoreference | CornersGeoreference | ControlPointsGeoreference | nullish; set georeference(value: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish); } interface MediaElementBaseProperties { georeference?: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish; opacity?: number; } export interface MosaicRule extends Accessor, JSONSupport { } export class MosaicRule { /** * Indicates whether the sort should be ascending. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#ascending Read more...} */ ascending: boolean; /** * An array of raster Ids. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#lockRasterIds Read more...} */ lockRasterIds: number[] | nullish; /** * The mosaic method determines how the selected rasters are ordered. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method Read more...} */ method: "none" | "center" | "nadir" | "viewpoint" | "attribute" | "lock-raster" | "northwest" | "seamline"; /** * Defines a selection using a set of ObjectIDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#objectIds Read more...} */ objectIds: number[] | nullish; /** * Defines the mosaic operation used to resolve overlapping pixels. * * @default "first" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#operation Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method method} is set to `attribute`. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#sortField Read more...} */ sortField: string | nullish; /** * A constant value defining a reference or base value for the sort field when the mosaic {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method method} * is set to `attribute`. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#sortValue Read more...} */ sortValue: string | number; /** * The where clause determines which rasters will participate in the mosaic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#where Read more...} */ where: string | nullish; /** * Specifies the mosaic rule when defining how individual images should be mosaicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html Read more...} */ constructor(properties?: MosaicRuleProperties); /** * The raster function applied on items before mosaicking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#itemRasterFunction Read more...} */ get itemRasterFunction(): RasterFunction | nullish; set itemRasterFunction(value: RasterFunctionProperties | nullish); /** * The multidimensional definitions associated with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mosaicRule ImageryLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#multidimensionalDefinition Read more...} */ get multidimensionalDefinition(): DimensionalDefinition[] | nullish; set multidimensionalDefinition(value: DimensionalDefinitionProperties[] | nullish); /** * Defines the viewpoint location on which the ordering is defined based on the * distance from the viewpoint and the nadir of rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#viewpoint Read more...} */ get viewpoint(): Point | nullish; set viewpoint(value: PointProperties | nullish); /** * Creates a clone of the MosaicRule object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#clone Read more...} */ clone(): MosaicRule; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MosaicRule; } interface MosaicRuleProperties { /** * Indicates whether the sort should be ascending. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#ascending Read more...} */ ascending?: boolean; /** * The raster function applied on items before mosaicking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#itemRasterFunction Read more...} */ itemRasterFunction?: RasterFunctionProperties | nullish; /** * An array of raster Ids. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#lockRasterIds Read more...} */ lockRasterIds?: number[] | nullish; /** * The mosaic method determines how the selected rasters are ordered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method Read more...} */ method?: "none" | "center" | "nadir" | "viewpoint" | "attribute" | "lock-raster" | "northwest" | "seamline"; /** * The multidimensional definitions associated with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mosaicRule ImageryLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#multidimensionalDefinition Read more...} */ multidimensionalDefinition?: DimensionalDefinitionProperties[] | nullish; /** * Defines a selection using a set of ObjectIDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#objectIds Read more...} */ objectIds?: number[] | nullish; /** * Defines the mosaic operation used to resolve overlapping pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#operation Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method method} is set to `attribute`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#sortField Read more...} */ sortField?: string | nullish; /** * A constant value defining a reference or base value for the sort field when the mosaic {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#method method} * is set to `attribute`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#sortValue Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#viewpoint Read more...} */ viewpoint?: PointProperties | nullish; /** * The where clause determines which rasters will participate in the mosaic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html#where Read more...} */ where?: string | nullish; } export interface MultidimensionalSubset extends Accessor, JSONSupport { } export class MultidimensionalSubset { /** * The aggregated dimension names and their extents or ranges computed from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#subsetDefinitions subsetDefinitions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#dimensions Read more...} */ readonly dimensions: SubsetDimension[]; /** * The aggregated variables list computed from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#subsetDefinitions subsetDefinitions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#variables Read more...} */ readonly variables: string[]; /** * A subset of multidimensional raster data created by slicing the data along defined variables and dimensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html Read more...} */ constructor(properties?: MultidimensionalSubsetProperties); /** * The spatial area of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#areaOfInterest Read more...} */ get areaOfInterest(): Extent | Polygon | nullish; set areaOfInterest(value: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish); /** * The variable and dimension subset definitions to set the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#subsetDefinitions Read more...} */ get subsetDefinitions(): DimensionalDefinition[] | nullish; set subsetDefinitions(value: DimensionalDefinitionProperties[] | nullish); /** * Creates a deep clone of the MultidimensionalSubset object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#clone Read more...} */ clone(): MultidimensionalSubset; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MultidimensionalSubset; } interface MultidimensionalSubsetProperties { /** * The spatial area of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#areaOfInterest Read more...} */ areaOfInterest?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish; /** * The variable and dimension subset definitions to set the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#subsetDefinitions Read more...} */ subsetDefinitions?: DimensionalDefinitionProperties[] | nullish; } /** * Dimension name and its extent or range computed from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#subsetDefinitions subsetDefinitions} and it is added to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#dimensions dimensions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MultidimensionalSubset.html#SubsetDimension Read more...} */ export interface SubsetDimension { name: string; extent: number[]; } export interface OrderByInfo extends Accessor, JSONSupport { } export class OrderByInfo { /** * The number or date field whose values will be used to sort features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#field Read more...} */ field: string | nullish; /** * The sort order. * * @default "ascending" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#order Read more...} */ order: "ascending" | "descending"; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression * following the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#feature-sorting Arcade Feature Z Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * Class that allows you to define the drawing order of features in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html Read more...} */ constructor(properties?: OrderByInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#clone Read more...} */ clone(): OrderByInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): OrderByInfo; } interface OrderByInfoProperties { /** * The number or date field whose values will be used to sort features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#field Read more...} */ field?: string | nullish; /** * The sort order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#order Read more...} */ order?: "ascending" | "descending"; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression * following the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#feature-sorting Arcade Feature Z Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-OrderByInfo.html#valueExpression Read more...} */ valueExpression?: string | nullish; } export interface ParquetEncodingLocation extends Accessor, JSONSupport { } export class ParquetEncodingLocation { /** * The name of the field in the Parquet file that contains the latitude values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#latitudeFieldName Read more...} */ latitudeFieldName: string; /** * The name of the field in the Parquet file that contains the longitude values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#longitudeFieldName Read more...} */ longitudeFieldName: string; /** * The type of encoding used for the geometries in the parquet file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#type Read more...} */ readonly type: "location"; /** * The location format used to store geometries in Pparquet files. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html Read more...} */ constructor(properties?: ParquetEncodingLocationProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ParquetEncodingLocation; } interface ParquetEncodingLocationProperties { /** * The name of the field in the Parquet file that contains the latitude values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#latitudeFieldName Read more...} */ latitudeFieldName?: string; /** * The name of the field in the Parquet file that contains the longitude values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingLocation.html#longitudeFieldName Read more...} */ longitudeFieldName?: string; } export interface ParquetEncodingWkb extends Accessor, JSONSupport { } export class ParquetEncodingWkb { /** * The name of the primary geometry column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html#primaryFieldName Read more...} */ primaryFieldName: string; /** * The type of encoding used for the geometries in the parquet file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html#type Read more...} */ readonly type: "wkb"; /** * Well-Known Binary (WKB) is a binary format used to encode geometries before storing them in parquet files. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html Read more...} */ constructor(properties?: ParquetEncodingWkbProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ParquetEncodingWkb; } interface ParquetEncodingWkbProperties { /** * The name of the primary geometry column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-ParquetEncodingWkb.html#primaryFieldName Read more...} */ primaryFieldName?: string; } /** * Provides utility functions for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html ParquetLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-parquetUtils.html Read more...} */ interface parquetUtils { /** * Retrieves information about a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html ParquetLayer} from the first parquet file in the specified URLs array. * * @param urls An array of URLs pointing to parquet files. At least one url must be provided. * @param options An object specifying additional options. See the object specification table below for the properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-parquetUtils.html#getParquetLayerInfo Read more...} */ getParquetLayerInfo(urls: string[], options?: parquetUtilsGetParquetLayerInfoOptions): Promise; } export const parquetUtils: parquetUtils; /** * Contains an information inferred from the parquet files. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-parquetUtils.html#ParquetLayerInfo Read more...} */ export interface ParquetLayerInfo { urls: Collection; fields?: Field[]; encoding?: ParquetEncodingWkb | ParquetEncodingLocation | nullish; geometryType?: "point" | "polygon" | "polyline" | "multipoint"; objectIdField?: string; spatialReference?: SpatialReference; } export interface parquetUtilsGetParquetLayerInfoOptions { customParameters?: any; signal?: AbortSignal | nullish; } export class PixelBlock extends Accessor { /** * The height (or number of rows) of the PixelBlock in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#height Read more...} */ height: number; /** * An array of nodata mask. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#mask Read more...} */ mask: Uint8Array | nullish; /** * Indicates whether mask should be used as alpha values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#maskIsAlpha Read more...} */ maskIsAlpha: boolean; /** * A two dimensional array representing the pixels from the Image Service * displayed on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixels Read more...} */ pixels: ( | number[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array )[]; /** * The pixel type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixelType Read more...} */ pixelType: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128"; /** * An array of objects containing numeric statistical properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#statistics Read more...} */ statistics: PixelBlockStatistics[] | nullish; /** * Number of valid pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#validPixelCount Read more...} */ validPixelCount: number | nullish; /** * The width (or number of columns) of the PixelBlock in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#width Read more...} */ width: number; /** * An object representing the pixel arrays in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html Read more...} */ constructor(properties?: PixelBlockProperties); /** * Adds another plane to the PixelBlock. * * @param planeData The data to add to the PixelBlock. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#addData Read more...} */ addData(planeData: PixelBlockAddDataPlaneData): void; /** * Returns pixels and masks using a single array in bip format * (e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#getAsRGBA Read more...} */ getAsRGBA(): Uint8ClampedArray; /** * Similar to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#getAsRGBA getAsRGBA}, but returns floating point data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#getAsRGBAFloat Read more...} */ getAsRGBAFloat(): Float32Array; /** * Returns the plane band count of the PixelBlock. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#getPlaneCount Read more...} */ getPlaneCount(): number | nullish; } interface PixelBlockProperties { /** * The height (or number of rows) of the PixelBlock in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#height Read more...} */ height?: number; /** * An array of nodata mask. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#mask Read more...} */ mask?: Uint8Array | nullish; /** * Indicates whether mask should be used as alpha values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#maskIsAlpha Read more...} */ maskIsAlpha?: boolean; /** * A two dimensional array representing the pixels from the Image Service * displayed on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixels Read more...} */ pixels?: ( | number[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array )[]; /** * The pixel type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixelType Read more...} */ pixelType?: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128"; /** * An array of objects containing numeric statistical properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#statistics Read more...} */ statistics?: PixelBlockStatistics[] | nullish; /** * Number of valid pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#validPixelCount Read more...} */ validPixelCount?: number | nullish; /** * The width (or number of columns) of the PixelBlock in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#width Read more...} */ width?: number; } export interface PixelBlockAddDataPlaneData { pixels: number[]; statistics?: PixelBlockAddDataPlaneDataStatistics; } export interface PixelBlockAddDataPlaneDataStatistics { minValue: number; maxValue: number; noDataValue: number | nullish; } export interface PixelBlockStatistics { maxValue?: number; minValue?: number; noDataValue?: number | nullish; } export interface PlaybackInfo extends Accessor, JSONSupport, Clonable { } export class PlaybackInfo { /** * Describes the relationship between the layers video data width and height. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#aspectRatio Read more...} */ aspectRatio: string | nullish; /** * The file format that holds and organizes video content including the video * data, audio data and metadata. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#containerFormat Read more...} */ containerFormat: string | nullish; /** * The framerate of the video represents the number of frames per second of * the video layer media source. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#framerate Read more...} */ framerate: string | nullish; /** * The group of pictures (GOP) of the video. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#gop Read more...} */ gop: number | nullish; /** * Defines the key length value (KLV) data encoding standard applied to the * available metadata content within the stream. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#klv Read more...} */ klv: any | nullish; /** * The PlaybackInfo class provides information about the playback of a video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html Read more...} */ constructor(properties?: PlaybackInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PlaybackInfo; } interface PlaybackInfoProperties { /** * Describes the relationship between the layers video data width and height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#aspectRatio Read more...} */ aspectRatio?: string | nullish; /** * The file format that holds and organizes video content including the video * data, audio data and metadata. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#containerFormat Read more...} */ containerFormat?: string | nullish; /** * The framerate of the video represents the number of frames per second of * the video layer media source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#framerate Read more...} */ framerate?: string | nullish; /** * The group of pictures (GOP) of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#gop Read more...} */ gop?: number | nullish; /** * Defines the key length value (KLV) data encoding standard applied to the * available metadata content within the stream. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PlaybackInfo.html#klv Read more...} */ klv?: any | nullish; } export class PublishingInfo extends Accessor { /** * Layer's publishing status while the layer is being published to the portal. * * @default "unknown" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PublishingInfo.html#status Read more...} */ readonly status: "unknown" | "unavailable" | "publishing" | "published"; /** * Indicates if the layer's status is still being updated. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PublishingInfo.html#updating Read more...} */ readonly updating: boolean; /** * This stops when the status has been determined or when the layer is destroyed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PublishingInfo.html Read more...} */ constructor(properties?: PublishingInfoProperties); } interface PublishingInfoProperties { } export class RangeDomain extends Domain { /** * The maximum valid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#maxValue Read more...} */ maxValue: number | string; /** * The minimum valid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#minValue Read more...} */ minValue: number | string; /** * The domain type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#type Read more...} */ readonly type: "range"; /** * Range domains specify a valid {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#minValue minimum} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#maxValue maximum} valid value that * can be stored in numeric and date {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html#type fields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html Read more...} */ constructor(properties?: RangeDomainProperties); static fromJSON(json: any): RangeDomain; } interface RangeDomainProperties extends DomainProperties { /** * The maximum valid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#maxValue Read more...} */ maxValue?: number | string; /** * The minimum valid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html#minValue Read more...} */ minValue?: number | string; } export interface RasterBandInfo extends Accessor, JSONSupport { } export class RasterBandInfo { /** * The maximum wavelength of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#maxWavelength Read more...} */ maxWavelength: number | nullish; /** * The minimum wavelength of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#minWavelength Read more...} */ minWavelength: number | nullish; /** * The name of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#name Read more...} */ name: string; /** * The radiance bias of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#radianceBias Read more...} */ radianceBias: number | nullish; /** * The radiance gain of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#radianceGain Read more...} */ radianceGain: number | nullish; /** * The reflectance bias of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#reflectanceBias Read more...} */ reflectanceBias: number | nullish; /** * The reflectance gain of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#reflectanceGain Read more...} */ reflectanceGain: number | nullish; /** * The solar irradiance of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#solarIrradiance Read more...} */ solarIrradiance: number | nullish; /** * referenced by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#serviceRasterInfo ImageryLayer} or * module:geoscene/layers/ImageryTileLayer#rasterInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html Read more...} */ constructor(properties?: RasterBandInfoProperties); /** * Creates a deep clone of the raster band info object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#clone Read more...} */ clone(): RasterBandInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterBandInfo; } interface RasterBandInfoProperties { /** * The maximum wavelength of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#maxWavelength Read more...} */ maxWavelength?: number | nullish; /** * The minimum wavelength of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#minWavelength Read more...} */ minWavelength?: number | nullish; /** * The name of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#name Read more...} */ name?: string; /** * The radiance bias of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#radianceBias Read more...} */ radianceBias?: number | nullish; /** * The radiance gain of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#radianceGain Read more...} */ radianceGain?: number | nullish; /** * The reflectance bias of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#reflectanceBias Read more...} */ reflectanceBias?: number | nullish; /** * The reflectance gain of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#reflectanceGain Read more...} */ reflectanceGain?: number | nullish; /** * The solar irradiance of the band. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterBandInfo.html#solarIrradiance Read more...} */ solarIrradiance?: number | nullish; } export interface RasterFunction extends Accessor, JSONSupport { } export class RasterFunction { /** * The arguments for the raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#functionArguments Read more...} */ functionArguments: any; /** * The raster function name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#functionName Read more...} */ functionName: string | nullish; /** * Defines the pixel type of the output image. * * @default "unknown" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#outputPixelType Read more...} */ outputPixelType: | "c128" | "c64" | "f32" | "f64" | "s16" | "s32" | "s8" | "u1" | "u16" | "u2" | "u32" | "u4" | "u8" | "unknown"; /** * Property where Raster Function template is passed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#rasterFunctionDefinition Read more...} */ rasterFunctionDefinition: any | nullish; /** * The variable name for the raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#variableName Read more...} */ variableName: string | nullish; /** * Raster functions specify processing to be done to the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html Read more...} */ constructor(properties?: RasterFunctionProperties); /** * Creates a deep clone of the raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#clone Read more...} */ clone(): RasterFunction; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterFunction; } interface RasterFunctionProperties { /** * The arguments for the raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#functionArguments Read more...} */ functionArguments?: any; /** * The raster function name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#functionName Read more...} */ functionName?: string | nullish; /** * Defines the pixel type of the output image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#outputPixelType Read more...} */ outputPixelType?: | "c128" | "c64" | "f32" | "f64" | "s16" | "s32" | "s8" | "u1" | "u16" | "u2" | "u32" | "u4" | "u8" | "unknown"; /** * Property where Raster Function template is passed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#rasterFunctionDefinition Read more...} */ rasterFunctionDefinition?: any | nullish; /** * The variable name for the raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html#variableName Read more...} */ variableName?: string | nullish; } /** * Various constant values used by different raster functions when setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#rasterFunction ImageryTileLayer.rasterFunction} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#rasterFunction ImageryLayer.rasterFunction} properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionConstants.html Read more...} */ interface rasterFunctionConstants { readonly bandIndexType: rasterFunctionConstantsBandIndexType; readonly cellStatisticalOperation: rasterFunctionConstantsCellStatisticalOperation; readonly colormapName: rasterFunctionConstantsColormapName; readonly colorRampName: rasterFunctionConstantsColorRampName; readonly convolutionKernel: rasterFunctionConstantsConvolutionKernel; readonly curvatureType: rasterFunctionConstantsCurvatureType; readonly hillshadeType: rasterFunctionConstantsHillshadeType; localArithmeticOperation: rasterFunctionConstantsLocalArithmeticOperation; readonly localConditionalOperation: rasterFunctionConstantsLocalConditionalOperation; readonly localLogicalOperation: rasterFunctionConstantsLocalLogicalOperation; readonly localTrigonometricOperation: rasterFunctionConstantsLocalTrigonometricOperation; readonly missingBandAction: rasterFunctionConstantsMissingBandAction; readonly noDataInterpretation: rasterFunctionConstantsNoDataInterpretation; readonly slopeType: rasterFunctionConstantsSlopeType; readonly stretchType: rasterFunctionConstantsStretchType; } export const rasterFunctionConstants: rasterFunctionConstants; export interface rasterFunctionConstantsBandIndexType { userDefined: number; NDVI: number; NDVIRe: number; BAI: number; NBR: number; NDBI: number; NDMI: number; NDSI: number; GEMI: number; GVITM: number; PVI: number; Sultan: number; VARI: number; GNDVI: number; SAVI: number; TSAVI: number; MSAVI: number; SR: number; SRRe: number; MTVI2: number; RTVICore: number; CIRe: number; CIG: number; EVI: number; ironOxide: number; ferrousMinerals: number; clayMinerals: number; NDWI: number; WNDWI: number; MNDWI: number; } export interface rasterFunctionConstantsCellStatisticalOperation { majority: number; max: number; mean: number; med: number; min: number; minority: number; range: number; stddev: number; sum: number; variety: number; majorityIgnoreNoData: number; maxIgnoreNoData: number; meanIgnoreNoData: number; medIgnoreNoData: number; minIgnoreNoData: number; minorityIgnoreNoData: number; rangeIgnoreNoData: number; stddevIgnoreNoData: number; sumIgnoreNoData: number; varietyIgnoreNoData: number; } export interface rasterFunctionConstantsColormapName { random: string; NDVI: string; NDVI2: string; NDVI3: string; elevation: string; gray: string; hillshade: string; } export interface rasterFunctionConstantsColorRampName { aspect: string; blackToWhite: string; blueBright: string; blueLightToDark: string; blueGreenBright: string; blueGreenLightToDark: string; brownLightToDark: string; brownToBlueGreenDivergingBright: string; brownToBlueGreenDivergingDark: string; coefficientBias: string; coldToHotDiverging: string; conditionNumber: string; cyanToPurple: string; cyanLightToBlueDark: string; distance: string; elevation1: string; elevation2: string; errors: string; grayLightToDark: string; greenBright: string; greenLightToDark: string; greenToBlue: string; orangeBright: string; orangeLightToDark: string; partialSpectrum: string; partialSpectrum1Diverging: string; partialSpectrum2Diverging: string; pinkToYellowGreenDivergingBright: string; pinkToYellowGreenDivergingDark: string; precipitation: string; prediction: string; purpleBright: string; purpleToGreenDivergingBright: string; purpleToGreenDivergingDark: string; purpleBlueBright: string; purpleBlueLightToDark: string; purpleRedBright: string; purpleRedLightToDark: string; redBright: string; redLightToDark: string; redToBlueDivergingBright: string; redToBlueDivergingDark: string; redToGreen: string; redToGreenDivergingBright: string; redToGreenDivergingDark: string; slope: string; spectrumFullBright: string; spectrumFullDark: string; spectrumFullLight: string; surface: string; temperature: string; whiteToBlack: string; yellowToDarkRed: string; yellowToGreenToDarkBlue: string; yellowToRed: string; yellowGreenBright: string; yellowGreenLightToDark: string; } export interface rasterFunctionConstantsConvolutionKernel { userDefined: number; lineDetectionHorizontal: number; lineDetectionVertical: number; lineDetectionLeftDiagonal: number; lineDetectionRightDiagonal: number; gradientNorth: number; gradientWest: number; gradientEast: number; gradientSouth: number; gradientNorthEast: number; gradientNorthWest: number; smoothArithmeticMean: number; smoothing3x3: number; smoothing5x5: number; sharpen: number; sharpen2: number; sharpening3x3: number; sharpening5x5: number; laplacian3x3: number; laplacian5x5: number; sobelHorizontal: number; sobelVertical: number; pointSpread: number; none: number; } export interface rasterFunctionConstantsCurvatureType { standard: number; planform: number; profile: number; } export interface rasterFunctionConstantsHillshadeType { traditional: number; multidirectional: number; } export interface rasterFunctionConstantsLocalArithmeticOperation { plus: number; minus: number; times: number; sqrt: number; power: number; abs: number; divide: number; exp: number; exp10: number; exp2: number; int: number; float: number; ln: number; log10: number; log2: number; mod: number; negate: number; roundDown: number; roundUp: number; square: number; } export interface rasterFunctionConstantsLocalConditionalOperation { setNull: number; conditional: number; } export interface rasterFunctionConstantsLocalLogicalOperation { bitwiseAnd: number; bitwiseLeftShift: number; bitwiseNot: number; bitwiseOr: number; bitwiseRightShift: number; bitwiseXOr: number; booleanAnd: number; booleanNot: number; booleanOr: number; booleanXOr: number; equalTo: number; greaterThan: number; greaterThanEqual: number; lessThan: number; lessThanEqual: number; isNull: number; notEqual: number; } export interface rasterFunctionConstantsLocalTrigonometricOperation { acos: number; asin: number; atan: number; atanh: number; cos: number; cosh: number; sin: number; sinh: number; tan: number; tanh: number; acosh: number; asinh: number; atan2: number; } export interface rasterFunctionConstantsMissingBandAction { bestMatch: number; fail: number; } export interface rasterFunctionConstantsNoDataInterpretation { matchAny: number; matchAll: number; } export interface rasterFunctionConstantsSlopeType { degree: number; percentRise: number; adjusted: number; } export interface rasterFunctionConstantsStretchType { none: number; standardDeviation: number; histogramEqualization: number; minMax: number; percentClip: number; sigmoid: number; } /** * Various utility functions that create {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html RasterFunction} for imagery processing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html Read more...} */ interface rasterFunctionUtils { readonly defaultRaster: "$$"; /** * Creates a raster function that calculates the absolute value of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#abs Read more...} */ abs(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse cosine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#acos Read more...} */ acos(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic cosine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#acosh Read more...} */ acosh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates a statistical metric from all bands of input rasters. * * @param parameters Input parameters for calculating arguments of the statistics on input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#argStatistics Read more...} */ argStatistics(parameters: ArgStatisticsParameters | ArgStatisticsDurationParameters): RasterFunction; /** * Creates a raster function that calculates the inverse sine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#asin Read more...} */ asin(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic sine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#asinh Read more...} */ 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. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#aspect Read more...} */ aspect(parameters: rasterFunctionUtilsAspectParameters): RasterFunction; /** * Creates a raster function that calculates the inverse tangent of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#atan Read more...} */ atan(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the inverse tangent (based on x,y) of the pixels in a raster. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#atan2 Read more...} */ atan2(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the inverse hyperbolic tangent of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#atanh Read more...} */ atanh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate BAI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticBAI Read more...} */ bandArithmeticBAI(parameters: rasterFunctionUtilsBandArithmeticBAIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate CIg. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticCIg Read more...} */ bandArithmeticCIg(parameters: rasterFunctionUtilsBandArithmeticCIgParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate CIre. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticCIre Read more...} */ bandArithmeticCIre(parameters: rasterFunctionUtilsBandArithmeticCIreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate ClayMinerals. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticClayMinerals Read more...} */ bandArithmeticClayMinerals(parameters: rasterFunctionUtilsBandArithmeticClayMineralsParameters): RasterFunction; /** * Creates a custom Band Arithmetic function. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticCustom Read more...} */ bandArithmeticCustom(parameters: rasterFunctionUtilsBandArithmeticCustomParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate EVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticEVI Read more...} */ bandArithmeticEVI(parameters: rasterFunctionUtilsBandArithmeticEVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate FerrousMinerals. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticFerrousMinerals Read more...} */ bandArithmeticFerrousMinerals(parameters: rasterFunctionUtilsBandArithmeticFerrousMineralsParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GEMI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticGEMI Read more...} */ bandArithmeticGEMI(parameters: rasterFunctionUtilsBandArithmeticGEMIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GNDVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticGNDVI Read more...} */ bandArithmeticGNDVI(parameters: rasterFunctionUtilsBandArithmeticGNDVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate GVITM. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticGVITM Read more...} */ bandArithmeticGVITM(parameters: rasterFunctionUtilsBandArithmeticGVITMParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate IronOxide. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticIronOxide Read more...} */ bandArithmeticIronOxide(parameters: rasterFunctionUtilsBandArithmeticIronOxideParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MNDWI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticMNDWI Read more...} */ bandArithmeticMNDWI(parameters: rasterFunctionUtilsBandArithmeticMNDWIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MSAVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticMSAVI Read more...} */ bandArithmeticMSAVI(parameters: rasterFunctionUtilsBandArithmeticMSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate MTVI2. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticMTVI2 Read more...} */ bandArithmeticMTVI2(parameters: rasterFunctionUtilsBandArithmeticMTVI2Parameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NBR. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNBR Read more...} */ bandArithmeticNBR(parameters: rasterFunctionUtilsBandArithmeticNBRParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDBI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDBI Read more...} */ bandArithmeticNDBI(parameters: rasterFunctionUtilsBandArithmeticNDBIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDMI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDMI Read more...} */ bandArithmeticNDMI(parameters: rasterFunctionUtilsBandArithmeticNDMIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDSI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDSI Read more...} */ bandArithmeticNDSI(parameters: rasterFunctionUtilsBandArithmeticNDSIParameters): RasterFunction; /** * Creates a NDVI function. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDVI Read more...} */ bandArithmeticNDVI(parameters: rasterFunctionUtilsBandArithmeticNDVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDVIre. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDVIre Read more...} */ bandArithmeticNDVIre(parameters: rasterFunctionUtilsBandArithmeticNDVIreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate NDWI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticNDWI Read more...} */ bandArithmeticNDWI(parameters: rasterFunctionUtilsBandArithmeticNDWIParameters): RasterFunction; /** * CCreates a Band Arithmetic function to calculate PVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticPVI Read more...} */ bandArithmeticPVI(parameters: rasterFunctionUtilsBandArithmeticPVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate RTVICore. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticRTVICore Read more...} */ bandArithmeticRTVICore(parameters: rasterFunctionUtilsBandArithmeticRTVICoreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SAVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticSAVI Read more...} */ bandArithmeticSAVI(parameters: rasterFunctionUtilsBandArithmeticSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SR. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticSR Read more...} */ bandArithmeticSR(parameters: rasterFunctionUtilsBandArithmeticSRParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate SRre. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticSRre Read more...} */ bandArithmeticSRre(parameters: rasterFunctionUtilsBandArithmeticSRreParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate Sultan index. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticSultan Read more...} */ bandArithmeticSultan(parameters: rasterFunctionUtilsBandArithmeticSultanParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate TSAVI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticTSAVI Read more...} */ bandArithmeticTSAVI(parameters: rasterFunctionUtilsBandArithmeticTSAVIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate VARI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticVARI Read more...} */ bandArithmeticVARI(parameters: rasterFunctionUtilsBandArithmeticVARIParameters): RasterFunction; /** * Creates a Band Arithmetic function to calculate WNDWI. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bandArithmeticWNDWI Read more...} */ bandArithmeticWNDWI(parameters: rasterFunctionUtilsBandArithmeticWNDWIParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise And operation on the binary values of two input rasters. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseAnd Read more...} */ bitwiseAnd(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Left Shift operation on the binary values of two input rasters. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseLeftShift Read more...} */ bitwiseLeftShift(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Not (complement) operation on the binary value of an input raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseNot Read more...} */ bitwiseNot(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Or operation on the binary values of two input rasters. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseOr Read more...} */ bitwiseOr(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Right Shift operation on the binary values of two input rasters. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseRightShift Read more...} */ bitwiseRightShift(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Bitwise Xor operation on the binary values of two input rasters. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#bitwiseXor Read more...} */ 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.geoscene.cn/zh/pro-app/latest/help/analysis/raster-functions/boolean-and-function.htm). * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#booleanAnd Read more...} */ booleanAnd(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs a Boolean Not (complement) operation on the pixel values of the input raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#booleanNot Read more...} */ 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.geoscene.cn/zh/pro-app/latest/help/analysis/raster-functions/boolean-or-function.htm). * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#booleanOr Read more...} */ 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.geoscene.cn/zh/pro-app/latest/help/analysis/raster-functions/boolean-xor-function.htm). * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#booleanXor Read more...} */ booleanXor(parameters: Math2RastersParameters): RasterFunction; /** * Creates a Raster Calculator function that performs mathematical operations using a custom expression on a set of inputs. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#calculate Read more...} */ calculate(parameters: rasterFunctionUtilsCalculateParameters): RasterFunction; /** * Creates a raster function that calculates a statistic from multiple rasters, on a pixel-by-pixel basis. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#cellStatistics Read more...} */ cellStatistics(parameters: rasterFunctionUtilsCellStatisticsParameters): RasterFunction; /** * Extracts a portion of an image based on an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} geometry. * * @param parameters The clip parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#clip Read more...} */ clip(parameters: rasterFunctionUtilsClipParameters): RasterFunction; /** * Creates a Colormap function to define a colormap for a raster by specifying a corresponding color for each pixel value. * * @param parameters The parameters object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#colormap Read more...} */ colormap(parameters: RasterColormapByMapParameters | RasterColormapByNameParameters | RasterColormapByRampParameters): RasterFunction; /** * Works with a single band image service that has an internal color map. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#colormapToRGB Read more...} */ colormapToRGB(parameters: rasterFunctionUtilsColormapToRGBParameters): RasterFunction; /** * Creates a Color Space Conversion function that converts the color model between the hue, saturation, and value (HSV) color space and red, green, and blue (RGB). * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#colorspaceConversion Read more...} */ colorspaceConversion(parameters: rasterFunctionUtilsColorspaceConversionParameters): RasterFunction; /** * Creates a Composite Bands function to combine multiple inputs into one multiband raster. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#compositeBand Read more...} */ compositeBand(parameters: rasterFunctionUtilsCompositeBandParameters): RasterFunction; /** * Creates a Compute Change function that analyzes changes between two rasters. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#computeChange Read more...} */ computeChange(parameters: rasterFunctionUtilsComputeChangeParameters): 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. * * @param parameters The conditional parameters object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#conditional Read more...} */ 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. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#contrastBrightness Read more...} */ contrastBrightness(parameters: rasterFunctionUtilsContrastBrightnessParameters): RasterFunction; /** * Creates a Convolution function that performs filtering using the given kernel to enhance the image, e.g. * * @param parameters The parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#convolution Read more...} */ convolution(parameters: ConvolutionFunctionParameters | ConvolutionFunctionCustomParameters): RasterFunction; /** * Creates a raster function that calculates the cosine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#cos Read more...} */ cos(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic cosine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#cosh Read more...} */ cosh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Color Composite function that produces a three-band raster from a multiband raster dataset in which each band can use an algebraic calculation based on band algebra. * * @param parameters Input parameters for creating a custom color composite from input raster.. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#createColorComposite Read more...} */ createColorComposite(parameters: ColorCompositeByIdParameters | ColorCompositeByNameParameters): RasterFunction; /** * Creates a Curvature function that calculates the shape or curvature of the slope. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#curvature Read more...} */ curvature(parameters: rasterFunctionUtilsCurvatureParameters): RasterFunction; /** * Creates a raster function that divides the values of two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#divide Read more...} */ divide(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that performs an equal-to operation on two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#equalTo Read more...} */ equalTo(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the base e exponential of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#exp Read more...} */ exp(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 10 exponential of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#exp10 Read more...} */ exp10(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 2 exponential of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#exp2 Read more...} */ exp2(parameters: Math1RasterParameters): RasterFunction; /** * Creates an Extract Band function to extract one or more bands from a multiband raster. * * @param parameters The parameters object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#extractBand Read more...} */ extractBand(parameters: ExtractBandByIdParameters | ExtractBandByNameParameters | ExtractBandByWavelengthParameters): RasterFunction; /** * Creates a raster function that converts each pixel value of a raster into a floating-point representation. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#float Read more...} */ float(parameters: Math1RasterParameters): RasterFunction; /** * Converts a multiband image into a single-band grayscale image. * * @param parameters The grayscale parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#grayscale Read more...} */ grayscale(parameters: rasterFunctionUtilsGrayscaleParameters): RasterFunction; /** * Creates a raster function that performs a relational greater-than operation on two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#greaterThan Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#greaterThanEqual Read more...} */ greaterThanEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a hillshade function. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#hillshade Read more...} */ hillshade(parameters: rasterFunctionUtilsHillshadeParameters): RasterFunction; /** * Creates a raster function that converts each pixel value of a raster to an integer by truncation. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#int Read more...} */ int(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that determines which values from the input raster are NoData on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#isNull Read more...} */ isNull(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that performs a relational less-than operation on two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#lessThan Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#lessThanEqual Read more...} */ lessThanEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that calculates the natural logarithm (base e) of each pixel in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#log Read more...} */ log(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 10 logarithm of each pixel in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#log10 Read more...} */ log10(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the base 2 logarithm of each pixel in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#log2 Read more...} */ 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. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#mask Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#minus Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#mod Read more...} */ 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. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#negate Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#notEqual Read more...} */ notEqual(parameters: Math2RastersParameters): RasterFunction; /** * Creates a raster function that adds (sums) the values of two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#plus Read more...} */ 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. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#power Read more...} */ power(parameters: Math2RastersParameters): RasterFunction; /** * Creates a Remap function to change or reclassify the pixel values of the raster. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#remap Read more...} */ 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. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#roundDown Read more...} */ 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. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#roundUp Read more...} */ 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. * * @param parameters The set null parameters object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#setNull Read more...} */ setNull(parameters: SetNullParameters): RasterFunction; /** * The ShadedRelief function creates a color 3D model of the terrain by merging the images from the elevation-coded and hillshade methods. * * @param parameters The parameters used to generate the shaded relief raster function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#shadedRelief Read more...} */ shadedRelief(parameters: | ShadedReliefWithColorRampParameters | ShadedReliefWithColormapParameters | ShadedReliefWithColorRampNameParameters): RasterFunction; /** * Creates a raster function that calculates the sine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#sin Read more...} */ sin(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic sine of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#sinh Read more...} */ sinh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Slope function that calculates the rate of change of elevation for each digital elevation model (DEM) cell. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#slope Read more...} */ slope(parameters: rasterFunctionUtilsSlopeParameters): RasterFunction; /** * Creates a Spectral Conversion function that applies a matrix to a multiband image to affect the color values of the output. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#spectralConversion Read more...} */ spectralConversion(parameters: rasterFunctionUtilsSpectralConversionParameters): RasterFunction; /** * Creates a raster function that calculates the square root of the pixel values in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#sqrt Read more...} */ sqrt(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the square of the pixel values in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#square Read more...} */ square(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Statistics function that calculates focal statistics for each pixel of an image based on a defined focal neighborhood. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#statistics Read more...} */ statistics(parameters: rasterFunctionUtilsStatisticsParameters): RasterFunction; /** * Creates a Statistics And Histogram function to define the statistics and histogram of a raster. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#statisticsHistogram Read more...} */ statisticsHistogram(parameters: rasterFunctionUtilsStatisticsHistogramParameters): RasterFunction; /** * Creates a Stretch function using min-max stretch type. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#stretchMinMax Read more...} */ stretchMinMax(parameters: rasterFunctionUtilsStretchMinMaxParameters): RasterFunction; /** * Creates a Stretch function without a specific stretch method. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#stretchNone Read more...} */ stretchNone(parameters: rasterFunctionUtilsStretchNoneParameters): RasterFunction; /** * Creates a Stretch function using percent-clip stretch type. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#stretchPercentClip Read more...} */ stretchPercentClip(parameters: rasterFunctionUtilsStretchPercentClipParameters): RasterFunction; /** * Creates a Stretch function using standard-deviation stretch type. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#stretchStandardDeviation Read more...} */ stretchStandardDeviation(parameters: rasterFunctionUtilsStretchStandardDeviationParameters): RasterFunction; /** * Creates an Attribute Table function to specify an attribute table for the input categorical raster. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#table Read more...} */ table(parameters: rasterFunctionUtilsTableParameters): RasterFunction; /** * Creates a raster function that calculates the tangent of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#tan Read more...} */ tan(parameters: Math1RasterParameters): RasterFunction; /** * Creates a raster function that calculates the hyperbolic tangent of the pixels in a raster. * * @param parameters Input parameters for performing math operations on an input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#tanh Read more...} */ tanh(parameters: Math1RasterParameters): RasterFunction; /** * Creates a Tasseled Cap (Kauth-Thomas) transformation function to analyze and map vegetation phenomenology and urban development changes detected by various satellite sensor systems. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#tasseledCap Read more...} */ tasseledCap(parameters: rasterFunctionUtilsTasseledCapParameters): RasterFunction; /** * Creates a Threshold function that creates a binary output, with 1 representing high pixel values. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#threshold Read more...} */ threshold(parameters: rasterFunctionUtilsThresholdParameters): RasterFunction; /** * Creates a raster function that multiplies the values of two rasters on a pixel-by-pixel basis. * * @param parameters Input parameters for performing math operations on two input rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#times Read more...} */ times(parameters: Math2RastersParameters): RasterFunction; /** * Creates a Transpose Bits function that unpacks the bits of the input pixel and maps them to specified bit locations in the output pixel. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#transposeBits Read more...} */ transposeBits(parameters: rasterFunctionUtilsTransposeBitsParameters): RasterFunction; /** * Creates a Weighted Overlay function that overlays several rasters using a common measurement scale and weights each according to its importance. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#weightedOverlay Read more...} */ weightedOverlay(parameters: rasterFunctionUtilsWeightedOverlayParameters): RasterFunction; /** * Creates a Weighted Sum function that adds up several rasters weighted by their importance. * * @param parameters The parameters object has the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#weightedSum Read more...} */ weightedSum(parameters: rasterFunctionUtilsWeightedSumParameters): RasterFunction; } export const rasterFunctionUtils: rasterFunctionUtils; /** * Arg statistics input parameters for duration statistics type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ArgStatisticsDurationParameters Read more...} */ export interface ArgStatisticsDurationParameters { statisticsType: "duration"; minValue: number; maxValue: number; rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } /** * Arg statistics input parameters for min, max, and median statistics type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ArgStatisticsParameters Read more...} */ export interface ArgStatisticsParameters { statisticsType: "min" | "max" | "median"; undefinedClass?: number; rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } /** * Create color composite input parameters using band ids. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ColorCompositeByIdParameters Read more...} */ export interface ColorCompositeByIdParameters { method: "id"; redBand: number; greenBand: number; blueBand: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Create color composite input parameters using band names or expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ColorCompositeByNameParameters Read more...} */ export interface ColorCompositeByNameParameters { method: "name"; redBand: string; greenBand: string; blueBand: string; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Conditional parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ConditionalParameters Read more...} */ export interface ConditionalParameters { raster: RasterPrimaryArgument; trueRaster: RasterArgument; falseRaster: RasterArgument; outputPixelType?: OutputPixelType; } export interface ConvolutionFunctionCustomParameters { convolutionType?: "user-defined"; rows: number; cols: number; kernel: number[]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface ConvolutionFunctionParameters { convolutionType: | "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"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Extract bands parameters specified using band ids. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ExtractBandByIdParameters Read more...} */ export interface ExtractBandByIdParameters { bandIds: number[]; missingBandAction?: "fail" | "best-match"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Extract bands parameters specified using band names. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ExtractBandByNameParameters Read more...} */ export interface ExtractBandByNameParameters { bandNames: string[]; missingBandAction?: "fail" | "best-match"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Extract bands parameters specified using band wavelengths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ExtractBandByWavelengthParameters Read more...} */ export interface ExtractBandByWavelengthParameters { bandWavelengths: number[]; missingBandAction?: "fail" | "best-match"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Input parameters for performing math operations on one input raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#Math1RasterParameters Read more...} */ export interface Math1RasterParameters { raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Input parameters for perform math operations between two rasters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#Math2RastersParameters Read more...} */ export interface Math2RastersParameters { raster: RasterArgument; raster2: RasterArgument; outputPixelType?: OutputPixelType; } /** * The output pixel type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#OutputPixelType Read more...} */ export type OutputPixelType = "unknown" | "s8" | "s16" | "s32" | "u8" | "u16" | "u32" | "f32" | "f64"; /** * Range map pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#PixelValueRangeMap Read more...} */ export interface PixelValueRangeMap { range: [number, number]; output: number; } /** * Raster argument used to specify raster(s) used in raster processing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterArgument Read more...} */ export type RasterArgument = RasterPrimaryArgument | number; /** * Raster colormap input parameters specified using a colormap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterColormapByMapParameters Read more...} */ export interface RasterColormapByMapParameters { colormap: RasterValueToColor[] | number[][]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Raster colormap input parameters specified using colormap name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterColormapByNameParameters Read more...} */ export interface 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" | "hillshade" | "gray" | "elevation" | "ndvi" | "ndvi2" | "ndvi3" | "random"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * Raster colormap input parameters specified using a colorramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterColormapByRampParameters Read more...} */ export interface RasterColormapByRampParameters { colorRamp: AlgorithmicColorRamp | MultipartColorRamp; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsAspectParameters { raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticBAIParameters { redBandId: number; nirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticCIgParameters { nirBandId: number; greenBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticCIreParameters { nirBandId: number; reBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticClayMineralsParameters { swir1BandId: number; swir2BandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticCustomParameters { bandIndexes: string; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticEVIParameters { nirBandId: number; redBandId: number; blueBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticFerrousMineralsParameters { swirBandId: number; nirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticGEMIParameters { nirBandId: number; redBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticGNDVIParameters { nirBandId: number; greenBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticGVITMParameters { bandIds: [number, number, number, number, number, number]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticIronOxideParameters { redBandId: number; blueBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticMNDWIParameters { greenBandId: number; swirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticMSAVIParameters { nirBandId: number; redBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticMTVI2Parameters { nirBandId: number; redBandId: number; greenBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNBRParameters { nirBandId: number; swirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDBIParameters { swirBandId: number; nirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDMIParameters { nirBandId: number; swirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDSIParameters { greenBandId: number; swirBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDVIParameters { nirBandId: number; redBandId: number; scientificOutput?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDVIreParameters { nirBandId: number; reBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticNDWIParameters { nirBandId: number; greenBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticPVIParameters { nirBandId: number; redBandId: number; slope?: number; gradient?: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticRTVICoreParameters { nirBandId: number; reBandId: number; greenBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticSAVIParameters { nirBandId: number; redBandId: number; factor?: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticSRParameters { nirBandId: number; redBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticSRreParameters { nirBandId: number; reBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticSultanParameters { bandIds: [number, number, number, number, number]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticTSAVIParameters { nirBandId: number; redBandId: number; slope?: number; intercept?: number; factor?: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticVARIParameters { redBandId: number; greenBandId: number; blueBandId: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsBandArithmeticWNDWIParameters { greenBandId: number; nirBandId: number; swirBandId: number; alpha?: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsCalculateParameters { inputNames: string[]; expression: string; rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsCellStatisticsParameters { rasters: RasterArgument[]; statisticsType: | "min" | "max" | "majority" | "mean" | "minority" | "range" | "stddev" | "sum" | "variety" | "median"; processAsMultiband?: boolean; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsClipParameters { geometry: Polygon | Extent; keepOutside?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsColormapToRGBParameters { raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsColorspaceConversionParameters { conversionType: "rgb-to-hsv" | "hsv-to-rgb"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsCompositeBandParameters { rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsComputeChangeParameters { method: | "difference" | "relative-difference" | "categorical" | "euclidean-distance" | "angle-difference" | "band-with-most-change"; keepMethod?: "all" | "changed" | "unchanged"; raster: RasterArgument; raster2: RasterArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsContrastBrightnessParameters { contrastOffset: number; brightnessOffset: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsCurvatureParameters { curvatureType: "standard" | "planform" | "profile"; zFactor: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsGrayscaleParameters { weights: number[]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsHillshadeParameters { hillshadeType: "traditional" | "multi-directional"; altitude?: number; azimuth?: number; zFactor: number; scalingType?: "none" | "adjusted"; pixelSizePower?: number; pixelSizeZFactor?: number; removeEdgeEffect?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsMaskParameters { includedRanges?: [number, number][]; noDataValues?: number[][]; noDataInterpretation?: "match-any" | "match-all"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsRemapParameters { rangeMaps: PixelValueRangeMap[]; allowUnmatched?: boolean; replacementValue?: number; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsSlopeParameters { slopeType: "degree" | "percent-rise" | "adjusted"; zFactor: number; pixelSizePower?: number; pixelSizeZFactor?: number; removeEdgeEffect?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsSpectralConversionParameters { conversionMatrix: number[] | number[][]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStatisticsHistogramParameters { statistics: RasterBandStatistics[]; histograms?: RasterHistogram[]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStatisticsParameters { statisticsType: "min" | "max" | "majority" | "mean" | "minority" | "stddev" | "median"; rows: number; cols: number; fillNoDataOnly?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStretchMinMaxParameters { statistics?: RasterBandStatistics[]; outputMin?: number; outputMax?: number; useGamma?: boolean; gamma?: number[]; dynamicRangeAdjustment?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStretchNoneParameters { outputMin?: number; outputMax?: number; useGamma?: boolean; gamma?: number[]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStretchPercentClipParameters { minPercent: number; maxPercent: number; outputMin?: number; outputMax?: number; useGamma?: boolean; gamma?: number[]; dynamicRangeAdjustment?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsStretchStandardDeviationParameters { numberOfStandardDeviations: number; outputMin?: number; outputMax?: number; useGamma?: boolean; gamma?: number[]; statistics?: RasterBandStatistics[]; dynamicRangeAdjustment?: boolean; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsTableParameters { attributeTable: FeatureSet; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsTasseledCapParameters { raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsThresholdParameters { raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsTransposeBitsParameters { inputBitPositions: number[]; outputBitPositions: number[]; raster?: RasterPrimaryArgument; fillRaster?: RasterArgument; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsWeightedOverlayParameters { weights: number[]; minScale: number; maxScale: number; valueToScaleMaps?: number[][][]; noDataValues?: number[][]; restrictedValues?: number[][]; fields?: string[]; rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } export interface rasterFunctionUtilsWeightedSumParameters { weights: number[]; fields?: string[]; rasters: RasterArgument[]; outputPixelType?: OutputPixelType; } /** * Raster argument used to specify raster(s) used in raster processing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterPrimaryArgument Read more...} */ export type RasterPrimaryArgument = RasterFunction | string; /** * A pixel value to color mapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#RasterValueToColor Read more...} */ export interface RasterValueToColor { value: number; color: number[] | string; } /** * SetNull parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#SetNullParameters Read more...} */ export interface SetNullParameters { raster: RasterPrimaryArgument; falseRaster: RasterArgument; outputPixelType?: OutputPixelType; } /** * The input parameters for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#shadedRelief shadedRelief} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ShadedReliefWithColormapParameters Read more...} */ export interface ShadedReliefWithColormapParameters { hillshadeType: "traditional" | "multi-directional"; altitude?: number; azimuth?: number; zFactor: number; scalingType?: "none" | "adjusted"; pixelSizePower?: number; pixelSizeZFactor?: number; removeEdgeEffect?: boolean; colormap: number[][]; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * The input parameters for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#shadedRelief shadedRelief} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ShadedReliefWithColorRampNameParameters Read more...} */ export interface ShadedReliefWithColorRampNameParameters { hillshadeType: "traditional" | "multi-directional"; altitude?: number; azimuth?: number; zFactor: number; scalingType?: "none" | "adjusted"; pixelSizePower?: number; pixelSizeZFactor?: number; removeEdgeEffect?: boolean; 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"; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } /** * The input parameters for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#shadedRelief shadedRelief} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-rasterFunctionUtils.html#ShadedReliefWithColorRampParameters Read more...} */ export interface ShadedReliefWithColorRampParameters { hillshadeType: "traditional" | "multi-directional"; altitude?: number; azimuth?: number; zFactor: number; scalingType?: "none" | "adjusted"; pixelSizePower?: number; pixelSizeZFactor?: number; removeEdgeEffect?: boolean; colorRamp: AlgorithmicColorRamp | MultipartColorRamp; raster?: RasterPrimaryArgument; outputPixelType?: OutputPixelType; } export interface RasterInfo extends Accessor, JSONSupport { } export class RasterInfo { /** * The raster attribute table associated with an imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#attributeTable Read more...} */ attributeTable: FeatureSet | nullish; /** * Raster band count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#bandCount Read more...} */ bandCount: number; /** * This property provides additional information for each band in the raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#bandInfos Read more...} */ readonly bandInfos: RasterBandInfo[]; /** * Raster colormap that can be used to display the imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#colormap Read more...} */ colormap: number[][] | nullish; /** * Raster data type controls how the data is rendered by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#dataType Read more...} */ readonly dataType: | "generic" | "elevation" | "thematic" | "processed" | "scientific" | "vector-uv" | "vector-u" | "vector-v" | "vector-magdir" | "vector-magnitude" | "vector-direction" | "standard-time"; /** * Indicates whether the source multidimensional data has been transposed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#hasMultidimensionalTranspose Read more...} */ hasMultidimensionalTranspose: boolean; /** * Raster height (row count) in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#height Read more...} */ height: number; /** * Raster histograms return basic name-value pairs for number of bins, min and * max bounding values, counts of pixels in each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#histograms Read more...} */ histograms: any[] | nullish; /** * Raster key properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#keyProperties Read more...} */ keyProperties: any; /** * Returns the multidimensional information associated with the raster service referenced in an imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#multidimensionalInfo Read more...} */ multidimensionalInfo: RasterMultidimensionalInfo | nullish; /** * The pixel value representing no available information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#noDataValue Read more...} */ noDataValue: number | (number | nullish)[] | nullish; /** * Raster pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#pixelSize Read more...} */ pixelSize: RasterInfoPixelSize; /** * Pixel type for the raster data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#pixelType Read more...} */ pixelType: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128"; /** * The sensor information associated with an image service referenced by a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#sensorInfo Read more...} */ readonly sensorInfo: RasterSensorInfo | nullish; /** * Raster band statistics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#statistics Read more...} */ statistics: RasterInfoStatistics[] | nullish; /** * Raster width (column count) in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#width Read more...} */ width: number; /** * Describes general raster data information exposed by the GeoScene REST API for * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html WCSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html Read more...} */ constructor(properties?: RasterInfoProperties); /** * The minimum and maximum X and Y coordinates of a bounding box containing all the raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#extent Read more...} */ get extent(): Extent; set extent(value: ExtentProperties); /** * The spatial reference of the raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterInfo; } interface RasterInfoProperties { /** * The raster attribute table associated with an imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#attributeTable Read more...} */ attributeTable?: FeatureSet | nullish; /** * Raster band count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#bandCount Read more...} */ bandCount?: number; /** * Raster colormap that can be used to display the imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#colormap Read more...} */ colormap?: number[][] | nullish; /** * The minimum and maximum X and Y coordinates of a bounding box containing all the raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#extent Read more...} */ extent?: ExtentProperties; /** * Indicates whether the source multidimensional data has been transposed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#hasMultidimensionalTranspose Read more...} */ hasMultidimensionalTranspose?: boolean; /** * Raster height (row count) in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#height Read more...} */ height?: number; /** * Raster histograms return basic name-value pairs for number of bins, min and * max bounding values, counts of pixels in each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#histograms Read more...} */ histograms?: any[] | nullish; /** * Raster key properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#keyProperties Read more...} */ keyProperties?: any; /** * Returns the multidimensional information associated with the raster service referenced in an imagery layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#multidimensionalInfo Read more...} */ multidimensionalInfo?: RasterMultidimensionalInfo | nullish; /** * The pixel value representing no available information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#noDataValue Read more...} */ noDataValue?: number | (number | nullish)[] | nullish; /** * Raster pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#pixelSize Read more...} */ pixelSize?: RasterInfoPixelSize; /** * Pixel type for the raster data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#pixelType Read more...} */ pixelType?: | "unknown" | "s8" | "s16" | "s32" | "u1" | "u2" | "u4" | "u8" | "u16" | "u32" | "f32" | "f64" | "c64" | "c128"; /** * The spatial reference of the raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * Raster band statistics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#statistics Read more...} */ statistics?: RasterInfoStatistics[] | nullish; /** * Raster width (column count) in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#width Read more...} */ width?: number; } export interface RasterInfoPixelSize { x: number; y: number; } export interface RasterInfoStatistics { min: number; max: number; stddev?: number; avg?: number; } /** * RasterMultidimensionalInfo contains dimensions for each variable in the service describing information about the images collected at multiple times, depths, or heights. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#RasterMultidimensionalInfo Read more...} */ export interface RasterMultidimensionalInfo { variables: RasterMultidimensionalInfoVariables[]; } export interface RasterMultidimensionalInfoVariables { name: string; description?: string | nullish; unit?: string | nullish; dimensions: RasterMultidimensionalInfoVariablesDimensions[]; statistics?: RasterBandStatistics[] | nullish; histograms?: RasterHistogram[] | nullish; } export interface RasterMultidimensionalInfoVariablesDimensions { name: string; description?: string | nullish; unit?: string | nullish; values?: number[] | number[][] | nullish; hasRanges?: boolean | nullish; hasRegularIntervals?: boolean | nullish; recurring?: boolean | nullish; interval?: number | nullish; intervalUnit?: string | nullish; extent?: number[]; } export interface RasterSensorInfo extends Accessor, JSONSupport { } export class RasterSensorInfo { /** * The cloud coverage (0-1). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#cloudCover Read more...} */ cloudCover: number | nullish; /** * The satellite product name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#productName Read more...} */ productName: string | nullish; /** * The sensor azimuth. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorAzimuth Read more...} */ sensorAzimuth: number | nullish; /** * The sensor elevation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorElevation Read more...} */ sensorElevation: number | nullish; /** * The sensor name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorName Read more...} */ sensorName: string; /** * The sun azimuth. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sunAzimuth Read more...} */ sunAzimuth: number | nullish; /** * The sun elevation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sunElevation Read more...} */ sunElevation: number | nullish; /** * The `RasterSensorInfo` class provides additional information on the raster sensor associated with an image service * referenced by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#serviceRasterInfo ImageryLayer} or * module:geoscene/layers/ImageryTileLayer#rasterInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html Read more...} */ constructor(properties?: RasterSensorInfoProperties); /** * The acquisition date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#acquisitionDate Read more...} */ get acquisitionDate(): Date | nullish; set acquisitionDate(value: DateProperties | nullish); /** * Creates a deep clone of the raster sensor info object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#clone Read more...} */ clone(): RasterSensorInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterSensorInfo; } interface RasterSensorInfoProperties { /** * The acquisition date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#acquisitionDate Read more...} */ acquisitionDate?: DateProperties | nullish; /** * The cloud coverage (0-1). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#cloudCover Read more...} */ cloudCover?: number | nullish; /** * The satellite product name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#productName Read more...} */ productName?: string | nullish; /** * The sensor azimuth. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorAzimuth Read more...} */ sensorAzimuth?: number | nullish; /** * The sensor elevation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorElevation Read more...} */ sensorElevation?: number | nullish; /** * The sensor name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sensorName Read more...} */ sensorName?: string; /** * The sun azimuth. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sunAzimuth Read more...} */ sunAzimuth?: number | nullish; /** * The sun elevation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterSensorInfo.html#sunElevation Read more...} */ sunElevation?: number | nullish; } export interface Relationship extends Accessor, JSONSupport, Clonable { } export class Relationship { /** * The cardinality which specifies the number of objects in the origin * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} related to the * number of objects in the destination {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#cardinality Read more...} */ cardinality: "one-to-one" | "one-to-many" | "many-to-many"; /** * The globally unique identifier for the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#catalogId Read more...} */ catalogId: string | nullish; /** * Indicates whether the relationship is composite. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#composite Read more...} */ composite: boolean; /** * The unique ID for the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#id Read more...} */ id: number; /** * The field used to establish the relate within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyField Read more...} */ keyField: string; /** * The key field in an attributed relationship class table that matches the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyField keyField}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyFieldInRelationshipTable Read more...} */ keyFieldInRelationshipTable: string; /** * The name of the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#name Read more...} */ name: string | nullish; /** * The unique ID of the related {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#relatedTableId Read more...} */ relatedTableId: number; /** * The relationship table id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#relationshipTableId Read more...} */ relationshipTableId: number; /** * Indicates whether the table participating in the relationship is the `origin` or `destination` table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#role Read more...} */ role: "origin" | "destination"; /** * Describes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html layer's} relationship with another layer or table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html Read more...} */ constructor(properties?: RelationshipProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Relationship; } interface RelationshipProperties { /** * The cardinality which specifies the number of objects in the origin * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} related to the * number of objects in the destination {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#cardinality Read more...} */ cardinality?: "one-to-one" | "one-to-many" | "many-to-many"; /** * The globally unique identifier for the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#catalogId Read more...} */ catalogId?: string | nullish; /** * Indicates whether the relationship is composite. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#composite Read more...} */ composite?: boolean; /** * The unique ID for the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#id Read more...} */ id?: number; /** * The field used to establish the relate within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyField Read more...} */ keyField?: string; /** * The key field in an attributed relationship class table that matches the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyField keyField}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#keyFieldInRelationshipTable Read more...} */ keyFieldInRelationshipTable?: string; /** * The name of the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#name Read more...} */ name?: string | nullish; /** * The unique ID of the related {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#relatedTableId Read more...} */ relatedTableId?: number; /** * The relationship table id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#relationshipTableId Read more...} */ relationshipTableId?: number; /** * Indicates whether the table participating in the relationship is the `origin` or `destination` table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html#role Read more...} */ role?: "origin" | "destination"; } export interface RouteStopSymbols extends Accessor, JSONSupport { } export class RouteStopSymbols { /** * RouteStopSymbols contains a set of symbols that will be used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} to symbolize * new stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html Read more...} */ constructor(properties?: RouteStopSymbolsProperties); /** * The default symbol for _break_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#break Read more...} */ get break(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set break(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for the first {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * @default { type: "simple-marker", color: [0, 255, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#first Read more...} */ get first(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set first(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for a _last_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * @default { type: "simple-marker", color: [255, 0, 0], size: 20, outline: { color: [255, 255, 255], width: 4 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#last Read more...} */ get last(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set last(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for _middle_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * @default { type: "simple-marker", color: [51, 51, 51],, size: 12, outline: { color: [0, 122, 194], width: 3 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#middle Read more...} */ get middle(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set middle(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for an _unlocated_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * @default { type: "simple-marker", color: [255, 0, 0], size: 12, outline: { color: [255, 255, 255], width: 3 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#unlocated Read more...} */ get unlocated(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set unlocated(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for _waypoint_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * @default { type: "simple-marker", color: [255, 255, 255], size: 12, outline: { color: [0, 122, 194], width: 3 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#waypoint Read more...} */ get waypoint(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set waypoint(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteStopSymbols; } interface RouteStopSymbolsProperties { /** * The default symbol for _break_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#break Read more...} */ break?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for the first {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#first Read more...} */ first?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for a _last_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#last Read more...} */ last?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for _middle_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#middle Read more...} */ middle?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for an _unlocated_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#unlocated Read more...} */ unlocated?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for _waypoint_ {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteStopSymbols.html#waypoint Read more...} */ waypoint?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; } export interface RouteSymbols extends Accessor, JSONSupport { } export class RouteSymbols { /** * RouteSymbols contains a set of symbols that will be used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} to symbolize * new stops, barriers and directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html Read more...} */ constructor(properties?: RouteSymbolsProperties); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionLines direction lines}. * * @default { type: "simple-line", color: [0, 122, 194], width: 6 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#directionLines Read more...} */ get directionLines(): SimpleLineSymbol | LineSymbol3D | CIMSymbol | nullish; set directionLines(value: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionPoints direction points}. * * @default { type: "simple-marker", color: [255, 255, 255], size: 6, outline: { color: [0, 122, 194], width: 2 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#directionPoints Read more...} */ get directionPoints(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set directionPoints(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers point barriers}. * * @default { type: "simple-marker", style: "x", size: 10, outline: { color: [255, 0, 0], width: 3 } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#pointBarriers Read more...} */ get pointBarriers(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol | nullish; set pointBarriers(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers polygon barriers}. * * @default { type: "simple-fill", color: [255, 170, 0, 0.6], outline: { width: 7.5, color: [255, 0, 0, 0.6] } } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#polygonBarriers Read more...} */ get polygonBarriers(): PictureFillSymbol | SimpleFillSymbol | PolygonSymbol3D | CIMSymbol | nullish; set polygonBarriers(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers polyline Barriers}. * * @default { type: "simple-line", color: [255, 85, 0, 0.7], width: 7.5 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#polylineBarriers Read more...} */ get polylineBarriers(): SimpleLineSymbol | LineSymbol3D | CIMSymbol | nullish; set polylineBarriers(value: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for the overall {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#routeInfo route}. * * @default { type: "simple-line", color: [20, 89, 127], width: 8 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#routeInfo Read more...} */ get routeInfo(): SimpleLineSymbol | LineSymbol3D | CIMSymbol | nullish; set routeInfo(value: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#stops Read more...} */ get stops(): RouteStopSymbols | nullish; set stops(value: RouteStopSymbolsProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteSymbols; } interface RouteSymbolsProperties { /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionLines direction lines}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#directionLines Read more...} */ directionLines?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#directionPoints direction points}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#directionPoints Read more...} */ directionPoints?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#pointBarriers point barriers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#pointBarriers Read more...} */ pointBarriers?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polygonBarriers polygon barriers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#polygonBarriers Read more...} */ polygonBarriers?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#polylineBarriers polyline Barriers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#polylineBarriers Read more...} */ polylineBarriers?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for the overall {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#routeInfo route}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#routeInfo Read more...} */ routeInfo?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The default symbol for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops stop}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RouteSymbols.html#stops Read more...} */ stops?: RouteStopSymbolsProperties | nullish; } export class SceneFilter extends Accessor { /** * The type of masking to perform. * * @default "disjoint" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#spatialRelationship Read more...} */ spatialRelationship: "disjoint" | "contains"; /** * A SceneFilter defines parameters for setting a client-side spatial filter on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#filter SceneLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html Read more...} */ constructor(properties?: SceneFilterProperties); /** * The geometries to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#geometries Read more...} */ get geometries(): Collection; set geometries(value: CollectionProperties); /** * Creates a deep clone of the SceneFilter object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#clone Read more...} */ clone(): SceneFilter; } interface SceneFilterProperties { /** * The geometries to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#geometries Read more...} */ geometries?: CollectionProperties; /** * The type of masking to perform. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneFilter.html#spatialRelationship Read more...} */ spatialRelationship?: "disjoint" | "contains"; } export interface SceneModification extends Accessor, JSONSupport { } export class SceneModification { /** * The type of modification to perform. * * @default "clip" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#type Read more...} */ type: "clip" | "mask" | "replace"; /** * A SceneModification is used to perform a client-side geometric modification. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html Read more...} */ constructor(properties?: SceneModificationProperties); /** * The geometry representing the location of the modification. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#geometry Read more...} */ get geometry(): Polygon | nullish; set geometry(value: PolygonProperties | nullish); /** * Creates a clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#clone Read more...} */ clone(): SceneModification; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SceneModification; } interface SceneModificationProperties { /** * The geometry representing the location of the modification. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#geometry Read more...} */ geometry?: PolygonProperties | nullish; /** * The type of modification to perform. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html#type Read more...} */ type?: "clip" | "mask" | "replace"; } export interface SceneModifications extends Collection, JSONSupport { } export class SceneModifications { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModification.html SceneModification} collection used to apply client-side * modifications to an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html#modifications IntegratedMeshLayer} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html#modifications IntegratedMesh3DTilesLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModifications.html Read more...} */ constructor(properties?: | SceneModificationsProperties | SceneModificationProperties[] | Collection); /** * Creates a clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModifications.html#clone Read more...} */ clone(): SceneModifications; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModifications.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SceneModifications.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SceneModifications; } type SceneModificationsProperties = CollectionProperties; export interface SiteLayerInfo extends Accessor, JSONSupport { } export class SiteLayerInfo { /** * The id for an operational layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#layerId Read more...} */ layerId: string | nullish; /** * The field name from the layer that defines the site name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#nameField Read more...} */ nameField: string | nullish; /** * The field name from the layer that defines a site unique ID for a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#siteIdField Read more...} */ siteIdField: string | nullish; /** * This value references the numeric ID of the sublayer if the Site layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#sublayerId Read more...} */ sublayerId: number | nullish; /** * The SiteLayerInfo class describes the boundaries of managed sites and is used for visualizing groups of facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html Read more...} */ constructor(properties?: SiteLayerInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SiteLayerInfo; } interface SiteLayerInfoProperties { /** * The id for an operational layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#layerId Read more...} */ layerId?: string | nullish; /** * The field name from the layer that defines the site name of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#nameField Read more...} */ nameField?: string | nullish; /** * The field name from the layer that defines a site unique ID for a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#siteIdField Read more...} */ siteIdField?: string | nullish; /** * This value references the numeric ID of the sublayer if the Site layer is a * map service sublayer instead of a feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SiteLayerInfo.html#sublayerId Read more...} */ sublayerId?: number | nullish; } /** * A web socket connection to a stream service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-StreamConnection.html Read more...} */ interface StreamConnection { readonly connectionError: Error | nullish; readonly connectionStatus: "connected" | "disconnected"; /** * Destroys the existing connection instance to the stream service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-StreamConnection.html#destroy Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#capabilities Read more...} */ readonly capabilities: SublayerCapabilities; /** * A SQL where clause used to filter features in the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * An array of fields in the Sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#fields Read more...} */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#field field} by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The full extent of the Sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#fullExtent Read more...} */ readonly fullExtent: Extent | nullish; /** * The sublayer's layer ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#id Read more...} */ id: number; /** * Returns `true` if the sublayer is a non-spatial table in a map service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#isTable Read more...} */ readonly isTable: boolean; /** * Indicates if labels for the sublayer will be visible in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html TileLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#layer Read more...} */ layer: MapImageLayer | TileLayer | nullish; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * @default "show" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#listMode Read more...} */ listMode: "show" | "hide" | "hide-children"; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#minScale Read more...} */ minScale: number; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#fields field} containing a unique value or identifier for each * feature in the Sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#objectIdField Read more...} */ readonly objectIdField: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#opacity Read more...} */ opacity: number; /** * The parent layer to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#parent Read more...} */ parent: Sublayer | MapImageLayer | TileLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} associated with the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#relationships Read more...} */ readonly relationships: Relationship[] | nullish; /** * An object that allows you to create a dynamic layer with data * either from the map service sublayers or data from a registered workspace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#source Read more...} */ source: DynamicMapLayer | DynamicDataLayer; /** * The [map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#sourceJSON Read more...} */ sourceJSON: any | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html spatial reference} of the sublayer as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference | nullish; /** * The title of the sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#title Read more...} */ title: string | nullish; readonly type: "sublayer"; /** * The name of the field holding the type ID or subtypes for the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#typeIdField Read more...} */ readonly typeIdField: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html types} defined in the feature service exposed by GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#types Read more...} */ readonly types: FeatureType[] | nullish; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * The URL to the REST endpoint of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#url Read more...} */ url: string | nullish; /** * Indicates if the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#visible Read more...} */ visible: boolean; /** * Represents a sublayer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html TileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Read more...} */ constructor(properties?: SublayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html LayerFloorInfo} object * which has a string property to represent the floorField. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#floorInfo Read more...} */ get floorInfo(): LayerFloorInfo | nullish; set floorInfo(value: LayerFloorInfoProperties | nullish); /** * The label definition for this layer, * specified as an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer to apply to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * If a sublayer contains sublayers, this * property is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer} * objects belonging to the given sublayer with sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#sublayers Read more...} */ get sublayers(): Collection; set sublayers(value: CollectionProperties); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a deep clone of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#clone Read more...} */ clone(): Sublayer; /** * A convenient method for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} instance * based on the Sublayer's configuration, including * [dynamic sources](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/linux/about-dynamic-layers.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#createFeatureLayer Read more...} */ createFeatureLayer(): Promise; /** * Creates a popup template for the sublayer, populated with all the fields of the sublayer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} object with * default values representing the layer's state, including filters (definition * expression) on the layer's features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureType.html FeatureType} describing the feature's type. * * @param feature A feature from this Sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#getFeatureType Read more...} */ getFeatureType(feature: Graphic | nullish): FeatureType | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: SublayerGetFieldDomainOptions): Domain | nullish; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Query information about attachments associated with features. * * @param attachmentQuery Specifies the attachment parameters for query. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryAttachments Read more...} */ queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: SublayerQueryAttachmentsOptions): void; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the sublayer and returns the number of features that * satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: SublayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html query} against features in the sublayer. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: SublayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the sublayer and returns an array of Object IDs for * features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: SublayerQueryObjectIdsOptions): Promise<(number | string)[]>; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the sublayer and returns * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSets} grouped by source layer or table objectIds. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryRelatedFeatures Read more...} */ queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: SublayerQueryRelatedFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the sublayer and when resolved, it returns * an `object` containing key value pairs. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#queryRelatedFeaturesCount Read more...} */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: SublayerQueryRelatedFeaturesCountOptions): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface SublayerProperties extends LoadableProperties, IdentifiableProperties { /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * A SQL where clause used to filter features in the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LayerFloorInfo.html LayerFloorInfo} object * which has a string property to represent the floorField. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#floorInfo Read more...} */ floorInfo?: LayerFloorInfoProperties | nullish; /** * The sublayer's layer ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#id Read more...} */ id?: number; /** * The label definition for this layer, * specified as an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates if labels for the sublayer will be visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html TileLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#layer Read more...} */ layer?: MapImageLayer | TileLayer | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#listMode Read more...} */ listMode?: "show" | "hide" | "hide-children"; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#minScale Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#opacity Read more...} */ opacity?: number; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * The parent layer to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#parent Read more...} */ parent?: Sublayer | MapImageLayer | TileLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer to apply to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * An object that allows you to create a dynamic layer with data * either from the map service sublayers or data from a registered workspace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#source Read more...} */ source?: DynamicMapLayer | DynamicDataLayer; /** * The [map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#sourceJSON Read more...} */ sourceJSON?: any | nullish; /** * If a sublayer contains sublayers, this * property is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer} * objects belonging to the given sublayer with sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#sublayers Read more...} */ sublayers?: CollectionProperties; /** * The title of the sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#title Read more...} */ title?: string | nullish; /** * The URL to the REST endpoint of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#url Read more...} */ url?: string | nullish; /** * Indicates if the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#visible Read more...} */ visible?: boolean; } /** * A dynamic data layer is a layer created on-the-fly with data stored in a * [registered workspace](https://enterprise.geosceneonline.cn/zh/server/latest/manage-data/windows/overview-register-data-with-geoscene-server.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#DynamicDataLayer Read more...} */ export interface DynamicDataLayer { type: "data-layer"; dataSource: TableDataSource | QueryTableDataSource | RasterDataSource | JoinTableDataSource; fields: DynamicDataLayerFields[]; } /** * A dynamic map layer refers to a layer published in a map service that has * dynamic layers enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#DynamicMapLayer Read more...} */ export interface DynamicMapLayer { type: "map-layer"; mapLayerId: number; gdbVersion: string; } /** * The result of an on-the-fly join operation at runtime. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#JoinTableDataSource Read more...} */ export interface JoinTableDataSource { type: "join-table"; leftTableKey: string; rightTableKey: string; leftTableSource: DynamicMapLayer | DynamicDataLayer; rightTableSource: DynamicMapLayer | DynamicDataLayer; joinType: "left-outer-join" | "left-inner-join"; } /** * A query table is a feature class or table defined by a SQL query on the fly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#QueryTableDataSource Read more...} */ export interface QueryTableDataSource { type: "query-table"; workspaceId: string; query: string; oidFields: string; spatialReference: SpatialReference; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch"; } /** * A file-based raster that resides in a registered raster workspace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#RasterDataSource Read more...} */ export interface RasterDataSource { type: "raster"; workspaceId: string; dataSourceName: string; } export interface SublayerCapabilities { attachment: SublayerCapabilitiesAttachment | nullish; data: SublayerCapabilitiesData; operations: SublayerCapabilitiesOperations; queryRelated: SublayerCapabilitiesQueryRelated; } export interface SublayerCapabilitiesAttachment { supportsResize: boolean; } export interface SublayerCapabilitiesData { supportsAttachment: boolean; } export interface SublayerCapabilitiesOperations { supportsQuery: boolean; supportsQueryAttachments: boolean; } export interface SublayerCapabilitiesQueryRelated { supportsCount: boolean; supportsOrderBy: boolean; supportsPagination: boolean; } export interface SublayerGetFieldDomainOptions { feature: Graphic; } export interface SublayerQueryAttachmentsOptions { signal?: AbortSignal | nullish; } export interface SublayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface SublayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface SublayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface SublayerQueryRelatedFeaturesCountOptions { signal?: AbortSignal | nullish; } export interface SublayerQueryRelatedFeaturesOptions { signal?: AbortSignal | nullish; } /** * A table or feature class that resides in a registered workspace (either a folder or geodatabase). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#TableDataSource Read more...} */ export interface TableDataSource { type: string; workspaceId: string; dataSourceName: string; gdbVersion: string; } export interface DynamicDataLayerFields { name: string; alias: string; } export interface Subtype extends Accessor, JSONSupport { } export class Subtype { /** * The subtype unique identifier number. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#code Read more...} */ code: number; /** * Name-value pairs of fields and their default field values associated with the subtype. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#defaultValues Read more...} */ defaultValues: any; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domains} associated with the subtype. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#domains Read more...} */ domains: HashMap | nullish; /** * The subtype name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#name Read more...} */ name: string; /** * Subtypes categorize a subset of features in a layer that share the same attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html Read more...} */ constructor(properties?: SubtypeProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Subtype; } interface SubtypeProperties { /** * The subtype unique identifier number. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#code Read more...} */ code?: number; /** * Name-value pairs of fields and their default field values associated with the subtype. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#defaultValues Read more...} */ defaultValues?: any; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domains} associated with the subtype. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#domains Read more...} */ domains?: HashMap | nullish; /** * The subtype name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Subtype.html#name Read more...} */ name?: string; } export interface SubtypeSublayer extends Accessor, Loadable, Identifiable { } export class SubtypeSublayer { /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Determines if the layer is editable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#editingEnabled Read more...} */ editingEnabled: boolean; /** * Describes effective capabilities of the layer taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#effectiveCapabilities Read more...} */ readonly effectiveCapabilities: Capabilities | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#effectiveEditingEnabled Read more...} */ readonly effectiveEditingEnabled: boolean; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#fields Read more...} */ readonly fields: Field[]; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex | nullish; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#geometryType Read more...} */ readonly geometryType: "point" | "multipoint" | "polyline" | "polygon" | "multipatch" | "mesh" | nullish; /** * The name of an `guid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#globalIdField Read more...} */ readonly globalIdField: string | nullish; /** * The unique ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#id Read more...} */ id: string; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * @default "show" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#listMode Read more...} */ listMode: "show" | "hide"; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#minScale Read more...} */ minScale: number; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#objectIdField Read more...} */ readonly objectIdField: string; /** * The opacity of the layer. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#opacity Read more...} */ opacity: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html SubtypeGroupLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#parent Read more...} */ parent: SubtypeGroupLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html relationships} set up for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#relationships Read more...} */ readonly relationships: Relationship[] | nullish; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; /** * The unique identifier representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html SubtypeSublayer} * created from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html SubtypeGroupLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#subtypeCode Read more...} */ subtypeCode: number; /** * The name of the field which holds the id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#subtypes subtypes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#subtypeField Read more...} */ readonly subtypeField: string; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#title Read more...} */ title: string | nullish; readonly type: "subtype-sublayer"; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * The absolute URL of the REST endpoint of the feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#url Read more...} */ readonly url: string | nullish; /** * Indicates if the layer is visible in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#visible Read more...} */ visible: boolean; /** * Represents a sublayer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html SubtypeGroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html Read more...} */ constructor(properties?: SubtypeSublayerProperties); /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used in an associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#formTemplate Read more...} */ get formTemplate(): FormTemplate | nullish; set formTemplate(value: FormTemplateProperties | nullish); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * An array of feature templates defined in the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#templates Read more...} */ get templates(): FeatureTemplate[] | nullish; set templates(value: FeatureTemplateProperties[] | nullish); /** * Adds an attachment to a feature. * * @param feature Feature to associate with the added attachment. * @param attachment HTML form that contains a file upload field specifying the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#addAttachment Read more...} */ addAttachment(feature: Graphic, attachment: HTMLFormElement | FormData): Promise; /** * Applies edits to features in a layer. * * @param edits Object containing features and attachments to be added, updated or deleted. * @param options Additional edit options to specify when editing features or attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#applyEdits Read more...} */ applyEdits(edits: SubtypeSublayerApplyEditsEdits, options?: SubtypeSublayerApplyEditsOptions): Promise; /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameters that can be used to fetch features that * satisfy the layer's current filters, and definitions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#createQuery Read more...} */ createQuery(): Query; /** * Deletes attachments from a feature. * * @param feature Feature containing attachments to be deleted. * @param attachmentIds Ids of the attachments to be deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#deleteAttachments Read more...} */ deleteAttachments(feature: Graphic, attachmentIds: number[]): Promise; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string): Domain | nullish; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Query information about attachments associated with features. * * @param attachmentQuery Specifies the attachment parameters for query. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryAttachments Read more...} */ queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: SubtypeSublayerQueryAttachmentsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: SubtypeSublayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: SubtypeSublayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the service and returns an array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: SubtypeSublayerQueryObjectIdsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSets} grouped by source layer or table objectIds. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryRelatedFeatures Read more...} */ queryRelatedFeatures(relationshipQuery: RelationshipQueryProperties, options?: SubtypeSublayerQueryRelatedFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the feature service and * when resolved, it returns an `object` containing key value pairs. * * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#queryRelatedFeaturesCount Read more...} */ queryRelatedFeaturesCount(relationshipQuery: RelationshipQueryProperties, options?: SubtypeSublayerQueryRelatedFeaturesCountOptions): Promise; /** * Updates an existing attachment for a feature. * * @param feature The feature containing the attachment to be updated. * @param attachmentId Id of the attachment to be updated. * @param attachment HTML form that contains a file upload field pointing to the file to be added as an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#updateAttachment Read more...} */ updateAttachment(feature: Graphic, attachmentId: number, attachment: HTMLFormElement | FormData): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface SubtypeSublayerProperties extends LoadableProperties, IdentifiableProperties { /** * This property is used to configure the associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * Determines if the layer is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#editingEnabled Read more...} */ editingEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used in an associated layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#formTemplate Read more...} */ formTemplate?: FormTemplateProperties | nullish; /** * The unique ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#id Read more...} */ id?: string; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * Indicates how the layer should display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#listMode Read more...} */ listMode?: "show" | "hide"; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#minScale Read more...} */ minScale?: number; /** * The opacity of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#opacity Read more...} */ opacity?: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html SubtypeGroupLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#parent Read more...} */ parent?: SubtypeGroupLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * The unique identifier representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html SubtypeSublayer} * created from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SubtypeGroupLayer.html SubtypeGroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#subtypeCode Read more...} */ subtypeCode?: number; /** * An array of feature templates defined in the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#templates Read more...} */ templates?: FeatureTemplateProperties[] | nullish; /** * The title of the layer used to identify it in places such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#title Read more...} */ title?: string | nullish; /** * Indicates if the layer is visible in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-SubtypeSublayer.html#visible Read more...} */ visible?: boolean; } export interface SubtypeSublayerApplyEditsEdits { addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | any[]; addAttachments?: AttachmentEdit[]; updateAttachments?: AttachmentEdit[]; deleteAttachments?: string[]; } export interface SubtypeSublayerApplyEditsOptions { gdbVersion?: string; returnEditMoment?: boolean; returnServiceEditsOption?: "none" | "original-and-current-features"; rollbackOnFailureEnabled?: boolean; globalIdUsed?: boolean; } export interface SubtypeSublayerQueryAttachmentsOptions { signal?: AbortSignal | nullish; } export interface SubtypeSublayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface SubtypeSublayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface SubtypeSublayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface SubtypeSublayerQueryRelatedFeaturesCountOptions { signal?: AbortSignal | nullish; } export interface SubtypeSublayerQueryRelatedFeaturesOptions { signal?: AbortSignal | nullish; } export interface TelemetryData extends Accessor, JSONSupport, Clonable { } export class TelemetryData { /** * The TelemetryData class is used to represent the telemetry data for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html Read more...} */ constructor(properties?: TelemetryDataProperties); /** * The center of the frame. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#frameCenter Read more...} */ get frameCenter(): Point | nullish; set frameCenter(value: PointProperties | nullish); /** * The outline of the frame. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#frameOutline Read more...} */ get frameOutline(): Polygon | nullish; set frameOutline(value: PolygonProperties | nullish); /** * The line of sight. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#lineOfSight Read more...} */ get lineOfSight(): Polyline | nullish; set lineOfSight(value: PolylineProperties | nullish); /** * The location of the sensor. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#sensorLocation Read more...} */ get sensorLocation(): Point | nullish; set sensorLocation(value: PointProperties | nullish); /** * The trail of the sensor. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#sensorTrail Read more...} */ get sensorTrail(): Polyline | nullish; set sensorTrail(value: PolylineProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TelemetryData; } interface TelemetryDataProperties { /** * The center of the frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#frameCenter Read more...} */ frameCenter?: PointProperties | nullish; /** * The outline of the frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#frameOutline Read more...} */ frameOutline?: PolygonProperties | nullish; /** * The line of sight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#lineOfSight Read more...} */ lineOfSight?: PolylineProperties | nullish; /** * The location of the sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#sensorLocation Read more...} */ sensorLocation?: PointProperties | nullish; /** * The trail of the sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryData.html#sensorTrail Read more...} */ sensorTrail?: PolylineProperties | nullish; } export interface TelemetryDisplay extends Accessor, JSONSupport, Clonable { } export class TelemetryDisplay { /** * Determines if the frame image is displayed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frame Read more...} */ frame: boolean; /** * Determines if the frame center is displayed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frameCenter Read more...} */ frameCenter: boolean; /** * Determines if the frame outline is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frameOutline Read more...} */ frameOutline: boolean; /** * Determines if the line of sight is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#lineOfSight Read more...} */ lineOfSight: boolean; /** * Determines if the sensor location is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#sensorLocation Read more...} */ sensorLocation: boolean; /** * Determines if the sensor trail is displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#sensorTrail Read more...} */ sensorTrail: boolean; /** * The TelemetryDisplay class is used to choose what telemetry data to display on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html Read more...} */ constructor(properties?: TelemetryDisplayProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TelemetryDisplay; } interface TelemetryDisplayProperties { /** * Determines if the frame image is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frame Read more...} */ frame?: boolean; /** * Determines if the frame center is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frameCenter Read more...} */ frameCenter?: boolean; /** * Determines if the frame outline is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#frameOutline Read more...} */ frameOutline?: boolean; /** * Determines if the line of sight is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#lineOfSight Read more...} */ lineOfSight?: boolean; /** * Determines if the sensor location is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#sensorLocation Read more...} */ sensorLocation?: boolean; /** * Determines if the sensor trail is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TelemetryDisplay.html#sensorTrail Read more...} */ sensorTrail?: boolean; } export interface TileInfo extends Accessor, JSONSupport { } export class TileInfo { /** * The dots per inch (DPI) of the tiling scheme. * * @default 96 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#dpi Read more...} */ dpi: number; /** * Image format of the cached tiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#format Read more...} */ format: | "png" | "png8" | "png24" | "png32" | "jpg" | "dib" | "tiff" | "emf" | "ps" | "pdf" | "gif" | "svg" | "svgz" | "mixed" | "lerc" | "lerc2d" | "pbf" | "raw"; /** * Indicates if the tiling scheme supports wrap around. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#isWrappable Read more...} */ readonly isWrappable: boolean; /** * Size of tiles in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#size Read more...} */ size: number[]; /** * Contains information about the tiling scheme for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html TileLayers}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayers}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayers}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html VectorTileLayers}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html WebTileLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html Read more...} */ constructor(properties?: TileInfoProperties); /** * An array of levels of detail that define the tiling scheme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#lods Read more...} */ get lods(): LOD[]; set lods(value: LODProperties[]); /** * The tiling scheme origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#origin Read more...} */ get origin(): Point; set origin(value: PointProperties); /** * The spatial reference of the tiling schema. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Utility method used to convert a scale value to its corresponding zoom value. * * @param scale The scale value to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#scaleToZoom Read more...} */ scaleToZoom(scale: number): number; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#toJSON Read more...} */ toJSON(): any; /** * Utility method used to convert a zoom value to its corresponding scale value. * * @param zoom The zoom value to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#zoomToScale Read more...} */ zoomToScale(zoom: number): number; /** * A convenience method used to create a new TileInfo instance with preset properties like {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#lods LODs}. * * @param options An object that contains the size, scales, and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} used to compute the new TileInfo instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#create Read more...} */ static create(options?: TileInfoCreateOptions): TileInfo; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TileInfo; } interface TileInfoProperties { /** * The dots per inch (DPI) of the tiling scheme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#dpi Read more...} */ dpi?: number; /** * Image format of the cached tiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#format Read more...} */ format?: | "png" | "png8" | "png24" | "png32" | "jpg" | "dib" | "tiff" | "emf" | "ps" | "pdf" | "gif" | "svg" | "svgz" | "mixed" | "lerc" | "lerc2d" | "pbf" | "raw"; /** * An array of levels of detail that define the tiling scheme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#lods Read more...} */ lods?: LODProperties[]; /** * The tiling scheme origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#origin Read more...} */ origin?: PointProperties; /** * Size of tiles in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#size Read more...} */ size?: number[]; /** * The spatial reference of the tiling schema. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileInfo.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; } export interface TileInfoCreateOptions { size?: number; numLODs?: number; spatialReference?: SpatialReference; scales?: number[]; } export interface TileMatrixSet extends Accessor, JSONSupport { } export class TileMatrixSet { /** * The unique ID assigned to the TileMatrixSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#id Read more...} */ id: string; /** * Contains information about the tiling scheme for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html WMTSSublayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html Read more...} */ constructor(properties?: TileMatrixSetProperties); /** * The full extent of the TileMatrixSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#tileInfo Read more...} */ get tileInfo(): TileInfo | nullish; set tileInfo(value: TileInfoProperties | nullish); /** * Creates a deep clone of this TileMatrixSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#clone Read more...} */ clone(): TileMatrixSet; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TileMatrixSet; } interface TileMatrixSetProperties { /** * The full extent of the TileMatrixSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The unique ID assigned to the TileMatrixSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#id Read more...} */ id?: string; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties | nullish; } export interface TimeInfo extends Accessor, JSONSupport, Clonable { } export class TimeInfo { /** * The name of the field containing the end time information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField Read more...} */ endField: string | nullish; /** * The name of the field containing the start time information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField Read more...} */ startField: string | nullish; /** * Indicates the time instants that the layer has data for. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#stops Read more...} */ stops: Date[] | nullish; /** * The IANA time zone that dates are stored in. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#timeZone Read more...} */ timeZone: string | nullish; /** * The name of the field used to join or group discrete locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#trackIdField Read more...} */ trackIdField: string | nullish; /** * Time info represents the temporal data of a time-aware layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html Read more...} */ constructor(properties?: TimeInfoProperties); /** * The time extent defines the start time and end time for all data in the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent Read more...} */ get fullTimeExtent(): TimeExtent | nullish; set fullTimeExtent(value: TimeExtentProperties | nullish); /** * The time interval defines the granularity of the temporal data and allows you to * visualize the data at specified intervals using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html time slider widget}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#interval Read more...} */ get interval(): TimeInterval | nullish; set interval(value: TimeIntervalProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TimeInfo; } interface TimeInfoProperties { /** * The name of the field containing the end time information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField Read more...} */ endField?: string | nullish; /** * The time extent defines the start time and end time for all data in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent Read more...} */ fullTimeExtent?: TimeExtentProperties | nullish; /** * The time interval defines the granularity of the temporal data and allows you to * visualize the data at specified intervals using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html time slider widget}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#interval Read more...} */ interval?: TimeIntervalProperties | nullish; /** * The name of the field containing the start time information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField Read more...} */ startField?: string | nullish; /** * Indicates the time instants that the layer has data for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#stops Read more...} */ stops?: Date[] | nullish; /** * The IANA time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#timeZone Read more...} */ timeZone?: string | nullish; /** * The name of the field used to join or group discrete locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#trackIdField Read more...} */ trackIdField?: string | nullish; } export interface TrackInfo extends Accessor, JSONSupport, Clonable { } export class TrackInfo { /** * Indicates whether the track info is enabled. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#enabled Read more...} */ enabled: boolean; /** * The maximum number of observations to display per track. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayObservationsPerTrack Read more...} */ maxDisplayObservationsPerTrack: number; /** * Indicates whether to display the popup for the track as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupTemplate popupTemplate}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Indicates which field from the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html timeInfo} will be used to * calculate observation ages for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayDuration trackInfo.maxDisplayDuration}. * * @default "startTimeField" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#timeField Read more...} */ timeField: "timeReceived" | "startTimeField" | "endTimeField"; /** * TrackInfo provides information about how to display and analyze temporal data in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html Read more...} */ constructor(properties?: TrackInfoProperties); /** * An array of aggregate fields that summarize {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields layer.fields} * in all observations of the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#fields Read more...} */ get fields(): AggregateField[]; set fields(value: AggregateFieldProperties[]); /** * Configuration properties for displaying the latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#latestObservations Read more...} */ get latestObservations(): TrackPartInfo; set latestObservations(value: TrackPartInfoProperties); /** * The maximum age of displayed observations. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayDuration Read more...} */ get maxDisplayDuration(): TimeInterval | nullish; set maxDisplayDuration(value: TimeIntervalProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Configuration properties for displaying previous observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#previousObservations Read more...} */ get previousObservations(): TrackPartInfo; set previousObservations(value: TrackPartInfoProperties); /** * Configuration properties for displaying track lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#trackLines Read more...} */ get trackLines(): TrackPartInfo; set trackLines(value: TrackPartInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TrackInfo; } interface TrackInfoProperties { /** * Indicates whether the track info is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#enabled Read more...} */ enabled?: boolean; /** * An array of aggregate fields that summarize {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#fields layer.fields} * in all observations of the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#fields Read more...} */ fields?: AggregateFieldProperties[]; /** * Configuration properties for displaying the latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#latestObservations Read more...} */ latestObservations?: TrackPartInfoProperties; /** * The maximum age of displayed observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayDuration Read more...} */ maxDisplayDuration?: TimeIntervalProperties | nullish; /** * The maximum number of observations to display per track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayObservationsPerTrack Read more...} */ maxDisplayObservationsPerTrack?: number; /** * Indicates whether to display the popup for the track as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupTemplate popupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} to apply to the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * Configuration properties for displaying previous observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#previousObservations Read more...} */ previousObservations?: TrackPartInfoProperties; /** * Indicates which field from the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html timeInfo} will be used to * calculate observation ages for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#maxDisplayDuration trackInfo.maxDisplayDuration}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#timeField Read more...} */ timeField?: "timeReceived" | "startTimeField" | "endTimeField"; /** * Configuration properties for displaying track lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackInfo.html#trackLines Read more...} */ trackLines?: TrackPartInfoProperties; } export interface TrackPartInfo extends Accessor, JSONSupport, Clonable { } export class TrackPartInfo { /** * Indicates whether to display labels for the track. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the renderer of the track part is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#visible Read more...} */ visible: boolean; /** * TrackPartInfo provides information about how to render and label temporal data in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html Read more...} */ constructor(properties?: TrackPartInfoProperties); /** * Defines labels for the track part as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * The renderer used to style the track part. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#renderer Read more...} */ get renderer(): RendererUnion | nullish; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TrackPartInfo; } interface TrackPartInfoProperties { /** * Defines labels for the track part as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * The renderer used to style the track part. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }) | nullish; /** * Indicates whether the renderer of the track part is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TrackPartInfo.html#visible Read more...} */ visible?: boolean; } export interface VideoElement extends Accessor, Loadable, MediaElementBase { } export class VideoElement { /** * The video content referenced in the video element instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#content Read more...} */ readonly content: HTMLVideoElement | nullish; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The opacity of the element. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#opacity Read more...} */ declare opacity: MediaElementBase["opacity"]; /** * The element type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#type Read more...} */ readonly type: "video"; /** * The video element to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source media layer's source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#video Read more...} */ video: string | HTMLVideoElement | nullish; /** * Represents a video element referenced in the MediaLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html Read more...} */ constructor(properties?: VideoElementProperties); /** * The geographic location of the image or video element to be placed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#georeference Read more...} */ get georeference(): ExtentAndRotationGeoreference | CornersGeoreference | ControlPointsGeoreference | nullish; set georeference(value: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#cancelLoad Read more...} */ cancelLoad(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface VideoElementProperties extends LoadableProperties, MediaElementBaseProperties { /** * The geographic location of the image or video element to be placed on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#georeference Read more...} */ georeference?: | (ExtentAndRotationGeoreferenceProperties & { type: "extent-and-rotation" }) | (CornersGeoreferenceProperties & { type: "corners" }) | (ControlPointsGeoreferenceProperties & { type: "control-points" }) | nullish; /** * The opacity of the element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#opacity Read more...} */ opacity?: MediaElementBaseProperties["opacity"]; /** * The video element to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html#source media layer's source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoElement.html#video Read more...} */ video?: string | HTMLVideoElement | nullish; } export interface VideoTimeExtent extends Accessor, JSONSupport, Clonable { } export class VideoTimeExtent { /** * The duration of the video in seconds. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#duration Read more...} */ duration: number | nullish; /** * The timezone of the video. * * @default "UTC" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#timezone Read more...} */ timezone: string; /** * The VideoTimeExtent class is used to represent the temporal extent of a video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html Read more...} */ constructor(properties?: VideoTimeExtentProperties); /** * The end time of the video as a Date. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#end Read more...} */ get end(): Date | nullish; set end(value: DateProperties | nullish); /** * The start time of the video as a Date. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#start Read more...} */ get start(): Date | nullish; set start(value: DateProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VideoTimeExtent; } interface VideoTimeExtentProperties { /** * The duration of the video in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#duration Read more...} */ duration?: number | nullish; /** * The end time of the video as a Date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#end Read more...} */ end?: DateProperties | nullish; /** * The start time of the video as a Date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#start Read more...} */ start?: DateProperties | nullish; /** * The timezone of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-VideoTimeExtent.html#timezone Read more...} */ timezone?: string; } export interface WMSSublayer extends Accessor, Identifiable { } export class WMSSublayer { /** * Description for the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#description Read more...} */ description: string; /** * An array of time, elevation and other dimensions for the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#dimensions Read more...} */ readonly dimensions: (TimeDimension | ElevationDimension | GenericDimension)[] | nullish; /** * The id for the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#id Read more...} */ id: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html WMSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#layer Read more...} */ layer: WMSLayer | nullish; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * A string url pointing to a legend image for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#legendUrl Read more...} */ legendUrl: string | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#maxScale Read more...} */ maxScale: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#minScale Read more...} */ minScale: number; /** * Name of the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#name Read more...} */ name: string; /** * Returns a reference to the parent WMS sublayer or layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#parent Read more...} */ parent: WMSSublayer | WMSLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Indicates if the layer can be queried, i.e. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#queryable Read more...} */ queryable: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#spatialReferences Read more...} */ spatialReferences: number[] | nullish; /** * The title of the WMS sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#title Read more...} */ title: string | nullish; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates if the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#visible Read more...} */ visible: boolean; /** * Represents a sublayer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html WMSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html Read more...} */ constructor(properties?: WMSSublayerProperties); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#fullExtent Read more...} */ get fullExtent(): Extent; set fullExtent(value: ExtentProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); /** * Creates a deep clone of the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#clone Read more...} */ clone(): WMSSublayer; } interface WMSSublayerProperties extends IdentifiableProperties { /** * Description for the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#description Read more...} */ description?: string; /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties; /** * The id for the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#id Read more...} */ id?: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html WMSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#layer Read more...} */ layer?: WMSLayer | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * A string url pointing to a legend image for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#legendUrl Read more...} */ legendUrl?: string | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#maxScale Read more...} */ maxScale?: number; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#minScale Read more...} */ minScale?: number; /** * Name of the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#name Read more...} */ name?: string; /** * Returns a reference to the parent WMS sublayer or layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#parent Read more...} */ parent?: WMSSublayer | WMSLayer | nullish; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * Indicates if the layer can be queried, i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#queryable Read more...} */ queryable?: boolean; /** * List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#spatialReferences Read more...} */ spatialReferences?: number[] | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * The title of the WMS sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#title Read more...} */ title?: string | nullish; /** * Indicates if the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#visible Read more...} */ visible?: boolean; } /** * Elevation dimension information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#ElevationDimension Read more...} */ export interface ElevationDimension { name: "elevation"; } /** * Generic dimension information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#GenericDimension Read more...} */ export interface GenericDimension { name: string; } /** * Time dimension information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#TimeDimension Read more...} */ export interface TimeDimension { name: "time"; units: "ISO8601"; extent: Date[] | TimeDimensionInterval[]; default: Date[] | TimeDimensionInterval[]; multipleValues: boolean; nearestValue: boolean; } /** * The time dimension interval. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#TimeDimensionInterval Read more...} */ export interface TimeDimensionInterval { min: Date; max: Date; resolution: TimeDimensionIntervalResolution; } export interface TimeDimensionIntervalResolution { years: number; months: number; days: number; hours: number; minutes: number; seconds: number; } export interface WMTSStyle extends Accessor, JSONSupport { } export class WMTSStyle { /** * Description for the WMTS style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#description Read more...} */ description: string | nullish; /** * The unique ID assigned to the style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#id Read more...} */ id: string; /** * The URL to the legend which gets used in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#legendUrl Read more...} */ legendUrl: string | nullish; /** * The title of the WMTS style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#title Read more...} */ title: string | nullish; /** * Contains information about the WMTS Style for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html WMTSSublayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html Read more...} */ constructor(properties?: WMTSStyleProperties); /** * Creates a deep clone of the WMTSStyle. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#clone Read more...} */ clone(): WMTSStyle; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): WMTSStyle; } interface WMTSStyleProperties { /** * Description for the WMTS style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#description Read more...} */ description?: string | nullish; /** * The unique ID assigned to the style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#id Read more...} */ id?: string; /** * The URL to the legend which gets used in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#legendUrl Read more...} */ legendUrl?: string | nullish; /** * The title of the WMTS style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html#title Read more...} */ title?: string | nullish; } export interface WMTSSublayer extends Accessor, JSONSupport { } export class WMTSSublayer { /** * Description for the WMTS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#description Read more...} */ description: string; /** * The unique ID assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#id Read more...} */ id: string; /** * The map image format (MIME type) to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#imageFormat Read more...} */ imageFormat: string; /** * Supported image formats as retrieved from the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#imageFormats Read more...} */ imageFormats: string[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html WMTSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#layer Read more...} */ layer: WMTSLayer | nullish; /** * The parent {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html WMTSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#parent Read more...} */ parent: WMTSLayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html WMTSStyle} to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#styleId Read more...} */ styleId: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html TileMatrixSet} to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#tileMatrixSet Read more...} */ readonly tileMatrixSet: TileMatrixSet | nullish; /** * The id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html TileMatrixSet} to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#tileMatrixSetId Read more...} */ tileMatrixSetId: string; /** * The title of the WMTS sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#title Read more...} */ title: string | nullish; /** * Represents a sublayer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html WMTSLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html Read more...} */ constructor(properties?: WMTSSublayerProperties); /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * A collection of supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html WMTSStyle}s as retrieved from the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#styles Read more...} */ get styles(): Collection | nullish; set styles(value: CollectionProperties | nullish); /** * A collection of supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html TileMatrixSets}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#tileMatrixSets Read more...} */ get tileMatrixSets(): Collection | nullish; set tileMatrixSets(value: CollectionProperties | nullish); /** * Creates a deep clone of the WMTS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#clone Read more...} */ clone(): WMTSSublayer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): WMTSSublayer; } interface WMTSSublayerProperties { /** * Description for the WMTS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#description Read more...} */ description?: string; /** * The full extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The unique ID assigned to the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#id Read more...} */ id?: string; /** * The map image format (MIME type) to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#imageFormat Read more...} */ imageFormat?: string; /** * Supported image formats as retrieved from the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#imageFormats Read more...} */ imageFormats?: string[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html WMTSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#layer Read more...} */ layer?: WMTSLayer | nullish; /** * The parent {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html WMTSLayer} to which the sublayer belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#parent Read more...} */ parent?: WMTSLayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html WMTSStyle} to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#styleId Read more...} */ styleId?: string; /** * A collection of supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSStyle.html WMTSStyle}s as retrieved from the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#styles Read more...} */ styles?: CollectionProperties | nullish; /** * The id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html TileMatrixSet} to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#tileMatrixSetId Read more...} */ tileMatrixSetId?: string; /** * A collection of supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TileMatrixSet.html TileMatrixSets}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#tileMatrixSets Read more...} */ tileMatrixSets?: CollectionProperties | nullish; /** * The title of the WMTS sublayer used to identify it in places such as the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#title Read more...} */ title?: string | nullish; } export interface TileLayer extends Layer, SublayersOwner, GeoSceneMapService, GeoSceneCachedService, RefreshableLayer, ScaleRangeLayer, PortalLayer, BlendLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class TileLayer { /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#sublayers sublayers} * in the TileLayer including the sublayers of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#allSublayers Read more...} */ readonly allSublayers: Collection; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * The URL that points to the location of the layer's attribution data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#attributionDataUrl Read more...} */ readonly attributionDataUrl: string | nullish; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Indicates the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#capabilities Read more...} */ declare readonly capabilities: GeoSceneMapService["capabilities"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#copyright Read more...} */ declare copyright: GeoSceneCachedService["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Indicates if the layer has attribution data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#hasAttributionData Read more...} */ readonly hasAttributionData: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#legendEnabled Read more...} */ declare legendEnabled: GeoSceneMapService["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Resampling is enabled by default in 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} and 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#resampling Read more...} */ resampling: boolean; /** * The [tiled map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#sourceJSON Read more...} */ sourceJSON: any; /** * The spatial reference of the layer as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#spatialReference Read more...} */ declare readonly spatialReference: GeoSceneCachedService["spatialReference"]; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#sublayers Read more...} */ readonly sublayers: Collection | nullish; /** * An array of tile servers used for changing map tiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#tileServers Read more...} */ tileServers: string[]; readonly type: "tile"; /** * The URL of the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#url Read more...} */ url: string | nullish; /** * The version of GeoScene Server in which the map service is published. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#version Read more...} */ declare readonly version: GeoSceneMapService["version"]; /** * The TileLayer allows you work with a cached [map service](https://enterprise.geosceneonline.cn/zh/server/latest/publish-services/windows/what-is-a-map-service.htm) * exposed by the GeoScene Server REST API and add it to * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} as a tile layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html Read more...} */ constructor(properties?: TileLayerProperties); /** * The full extent of the layer as defined by the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the tables * in the layer including the tables of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#subtables Read more...} */ get subtables(): Collection | nullish; set subtables(value: CollectionProperties | nullish); /** * Contains information about the tiling scheme for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); /** * Returns a deep clone of a map service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html sublayers} as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#createServiceSublayers Read more...} */ createServiceSublayers(): Collection; /** * This method fetches a tile for the given level, row and column present in the view. * * @param level Level of detail of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param row The row(y) position of the tile fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param col The column(x) position of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param options Optional settings for the tile request. The options have the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#fetchTile Read more...} */ fetchTile(level: number, row: number, col: number, options?: TileLayerFetchTileOptions): Promise; /** * Returns the sublayer with the given layerId. * * @param id The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html#id id} of the sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#findSublayerById Read more...} */ findSublayerById(id: number): Sublayer | nullish; /** * This method returns a URL to a tile for a given level, row and column. * * @param level The requested tile's level. * @param row The requested tile's row. * @param col The requested tile's column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#getTileUrl Read more...} */ getTileUrl(level: number, row: number, col: number): string; /** * Loads all of the sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#loadAll Read more...} */ loadAll(): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#refresh Read more...} */ refresh(): void; 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, SublayersOwnerProperties, GeoSceneMapServiceProperties, GeoSceneCachedServiceProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, PortalLayerProperties, BlendLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#copyright Read more...} */ copyright?: GeoSceneCachedServiceProperties["copyright"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The full extent of the layer as defined by the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#legendEnabled Read more...} */ legendEnabled?: GeoSceneMapServiceProperties["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * Resampling is enabled by default in 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} and 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#resampling Read more...} */ resampling?: boolean; /** * The [tiled map service's metadata JSON](https://doc.geoscene.cn/rest/services-reference/map-service.htm) * exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#sourceJSON Read more...} */ sourceJSON?: any; /** * A flat {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of all the tables * in the layer including the tables of its sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#subtables Read more...} */ subtables?: CollectionProperties | nullish; /** * Contains information about the tiling scheme for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties; /** * An array of tile servers used for changing map tiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#tileServers Read more...} */ tileServers?: string[]; /** * The URL of the REST endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-TileLayer.html#url Read more...} */ url?: string | nullish; } 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 { signal?: AbortSignal | nullish; } export class UnknownLayer extends Layer { readonly type: "unknown"; /** * Represents a layer whose type could not be determined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-UnknownLayer.html Read more...} */ constructor(properties?: UnknownLayerProperties); } interface UnknownLayerProperties extends LayerProperties { } export class UnsupportedLayer extends Layer { readonly type: "unsupported"; /** * Represents an unsupported layer instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-UnsupportedLayer.html Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#apiKey Read more...} */ apiKey: string | nullish; /** * The URL that points to the location of the layer's attribution data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#attributionDataUrl Read more...} */ readonly attributionDataUrl: string | nullish; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Indicates the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#capabilities Read more...} */ readonly capabilities: VectorTileLayerCapabilities; /** * The current style information of the VectorTileLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo Read more...} */ readonly currentStyleInfo: VectorTileLayerCurrentStyleInfo; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#customParameters Read more...} */ customParameters: any; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The initial extent of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#initialExtent Read more...} */ readonly initialExtent: Extent | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#refreshInterval Read more...} */ refreshInterval: number; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; /** * A style JSON object of vector tiles that will be used to render the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#style Read more...} */ style: any; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#tileInfo Read more...} */ readonly 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#url Read more...} */ url: string | nullish; /** * VectorTileLayer accesses cached tiles of data and renders it in vector format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html Read more...} */ constructor(properties?: VectorTileLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * Deletes the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/) from the * VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) as specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#deleteStyleLayer Read more...} */ 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/). * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getLayoutProperties Read more...} */ 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/). * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getPaintProperties Read more...} */ getPaintProperties(layerId: string): any; /** * Returns an instance of a [style layer](https://maplibre.org/maplibre-style-spec/layers) * from the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getStyleLayer Read more...} */ 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. * * @param index Index of the style layer in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getStyleLayerId Read more...} */ getStyleLayerId(index: number): string | nullish; /** * Returns the index of the [style layer](https://maplibre.org/maplibre-style-spec/layers) from the VectorTileLayer's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * @param layerId The [style layer id](https://maplibre.org/maplibre-style-spec/layers/#id) as specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getStyleLayerIndex Read more...} */ getStyleLayerIndex(layerId: string): number; /** * Gets the visibility of the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/) from the * VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) as specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getStyleLayerVisibility Read more...} */ getStyleLayerVisibility(layerId: string): string; /** * Loads a style to render a layer from the specified URL to a style resource or style JSON object. * * @param style The URL to a style of vector tiles or style JSON object. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#loadStyle Read more...} */ loadStyle(style?: string | any | null, options?: VectorTileLayerLoadStyleOptions | null): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#refresh Read more...} */ refresh(): void; /** * 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/). * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * @param layout An instance of layout properties to assign to the style layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setLayoutProperties Read more...} */ 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). * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * @param painter An instance of paint properties to assign to the specified style layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setPaintProperties Read more...} */ setPaintProperties(layerId: string, painter: any): void; /** * Changes the sprite source associated with the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo current style}. * * @param spriteSourceInfo The sprite source info is used to set the sprites in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. The user can set the sprite source from a URL to fetch the sprite resources or from the image info to set the sprite resources directly on the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setSpriteSource Read more...} */ setSpriteSource(spriteSourceInfo: SpriteSourceImageInfo | SpriteSourceUrlInfo): Promise; /** * Changes the layer properties of the specified [style layer](https://maplibre.org/maplibre-style-spec/layers/). * * @param layer The [style layer](https://maplibre.org/maplibre-style-spec/layers/) specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. Get an instance of a style layer from a loaded style using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#getStyleLayer getStyleLayer} method. * @param index Index of the style layer in the style. Set this parameter when adding a new style layer or re-ordering a style layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setStyleLayer Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * * @param layerId The style layer [id](https://maplibre.org/maplibre-style-spec/layers/#id) as specified in the VectorTileLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#currentStyleInfo currentStyleInfo.style}. * @param visibility Set this parameter to `"none"` to hide the style layer or to `"visible"` to show the style layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setStyleLayerVisibility Read more...} */ setStyleLayerVisibility(layerId: string, visibility: "none" | "visible"): void; on(name: "refresh", eventHandler: VectorTileLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: VectorTileLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: VectorTileLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: VectorTileLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): VectorTileLayer; } interface VectorTileLayerProperties extends LayerProperties, OperationalLayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#apiKey Read more...} */ apiKey?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#customParameters Read more...} */ customParameters?: any; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#refreshInterval Read more...} */ refreshInterval?: number; /** * A style JSON object of vector tiles that will be used to render the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#style Read more...} */ style?: any; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#url Read more...} */ url?: string | nullish; } export type GetSpriteInfo = (name: string) => SpriteInfo | nullish; /** * Defines an image object that can be used when setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#SpriteSourceImageInfo SpriteSourceImageInfo}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#ImageObject Read more...} */ export interface ImageObject { width: number; height: number; data: ArrayBuffer; } export interface VectorTileLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface VectorTileLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface VectorTileLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface VectorTileLayerRefreshEvent { dataChanged: boolean; } /** * A description of each image contained in the sprite. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#SpriteInfo Read more...} */ export interface SpriteInfo { x: number; y: number; height: number; width: number; pixelRatio?: number; sdf?: boolean; } /** * The sprite source returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setSpriteSource setSpriteSource} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#SpriteSource Read more...} */ export interface SpriteSource { baseURL: string | nullish; loadStatus: "not-loaded" | "loading" | "loaded" | "failed"; devicePixelRatio: number; height: number; width: number; image: Uint8Array | nullish; getSpriteInfo: GetSpriteInfo; } /** * Defines sprite source from an image and index json when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setSpriteSource setSpriteSource()} method is called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#SpriteSourceImageInfo Read more...} */ export interface SpriteSourceImageInfo { type: "image"; spriteUrl?: string; pixelRatio?: number; spriteSource1x?: SpriteSourceImageInfoSpriteSource1x; spriteSource2x?: SpriteSourceImageInfoSpriteSource2x; } /** * The URL of the sprite source to be fetched when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#setSpriteSource setSpriteSource()} method is called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html#SpriteSourceUrlInfo Read more...} */ export interface SpriteSourceUrlInfo { type: string; spriteUrl: string; pixelRatio?: number; spriteFormat?: "png" | "webp"; } export interface VectorTileLayerCapabilities { exportTiles: VectorTileLayerCapabilitiesExportTiles | nullish; operations: VectorTileLayerCapabilitiesOperations; } export interface VectorTileLayerCapabilitiesExportTiles { maxExportTilesCount: number; } export interface VectorTileLayerCapabilitiesOperations { supportsExportTiles: boolean; supportsTileMap: boolean; } export interface VectorTileLayerCurrentStyleInfo { serviceUrl: string | nullish; styleUrl: string | nullish; spriteUrl: string | nullish; glyphsUrl: string | nullish; style: any; layerDefinition: any; } export interface VectorTileLayerLoadStyleOptions { signal?: AbortSignal | nullish; } export interface SpriteSourceImageInfoSpriteSource1x { image: HTMLImageElement | HTMLCanvasElement | any | ImageData | ImageObject; json: HashMap; } export interface SpriteSourceImageInfoSpriteSource2x { image: HTMLImageElement | HTMLCanvasElement | any | ImageData | ImageObject; json: HashMap; } export interface VideoLayer extends Layer, ScaleRangeLayer, BlendLayer { } export class VideoLayer { /** * Indicates if the video layer is configured to start playback when ready. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#autoplay Read more...} */ autoplay: boolean; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Represents the length of the currently buffered video in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#buffered Read more...} */ readonly buffered: number; /** * The capabilities of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#capabilities Read more...} */ readonly capabilities: VideoLayerCapabilities | nullish; /** * Defines the codecs on the media content of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#codecs Read more...} */ readonly codecs: Codecs | nullish; /** * The copyright information for the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#copyright Read more...} */ copyright: string | nullish; /** * The date the video layer was created. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#created Read more...} */ readonly created: Date | nullish; /** * The current time of the video layer in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#currentTime Read more...} */ currentTime: number; /** * The description of the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#description Read more...} */ description: string | nullish; /** * The duration of the video layer in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#duration Read more...} */ readonly duration: number; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Indicates if the video layer has ended and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#currentTime current time} is equal to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#duration duration} of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#ended Read more...} */ readonly ended: boolean; /** * The total number of frames in the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameCount Read more...} */ readonly frameCount: number | nullish; /** * Provides filter functions that can be performed on the video frame to * achieve different visual effects. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameEffect Read more...} */ frameEffect: Effect | nullish; /** * The opacity of the video frame draped on the map. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameOpacity Read more...} */ frameOpacity: number; /** * The active stream is loaded as a livestream video layer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#isLive Read more...} */ readonly isLive: boolean; /** * The layer id of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#layerId Read more...} */ readonly layerId: number | nullish; /** * Indicates if the video layer should loop. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#loop Read more...} */ loop: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The metadata for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#metadata Read more...} */ readonly metadata: globalThis.Map | nullish; /** * Defines the mime type of the active playback source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#mimeType Read more...} */ readonly mimeType: string | nullish; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Indicates if the video layer is muted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#muted Read more...} */ muted: boolean; /** * The playback rate of the video layer. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#playbackRate Read more...} */ playbackRate: number; /** * Indicates if the video layer is playing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#playing Read more...} */ readonly playing: boolean; /** * The URL to the poster image for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#posterUrl Read more...} */ readonly posterUrl: string | nullish; /** * The available video qualities for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#qualities Read more...} */ readonly qualities: ("sd" | "hd" | "fhd" | "qhd" | "uhd")[] | nullish; /** * The GeoScene Enterprise Portal item id of the video service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#serviceItemId Read more...} */ readonly serviceItemId: string | nullish; /** * The source quality of the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sourceQuality Read more...} */ readonly sourceQuality: "sd" | "hd" | "fhd" | "qhd" | "uhd" | nullish; /** * The source type of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sourceType Read more...} */ readonly sourceType: "ondemand" | "livestream" | nullish; /** * The playback start time in seconds since the beginning of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#start Read more...} */ start: number; /** * The layer play operation has been invoked at least one time. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#started Read more...} */ readonly started: boolean; /** * The current state of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#state Read more...} */ readonly state: "can-play" | "not-ready" | "paused" | "playing" | "ready" | "waiting" | "data-loaded" | nullish; /** * The telemetry data for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#telemetry Read more...} */ readonly telemetry: TelemetryData; readonly type: "video"; /** * The URL to the REST endpoint of the video service. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#url Read more...} */ url: string | nullish; /** * The video service version of this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#version Read more...} */ readonly version: number | nullish; /** * The height of the video in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#videoHeight Read more...} */ readonly videoHeight: number | nullish; /** * Defines layer information for video layers published within the same * video service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#videoLayersInfo Read more...} */ readonly videoLayersInfo: VideoServiceLayerInfo[] | nullish; /** * The time extent of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#videoTimeExtent Read more...} */ readonly videoTimeExtent: VideoTimeExtent | nullish; /** * The width of the video in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#videoWidth Read more...} */ readonly videoWidth: number | nullish; /** * The volume property sets or returns the audio volume of a video, from 0.0 * (silent) to 1.0 (loudest). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#volume Read more...} */ volume: number; /** * Indicates if the video layer is waiting for data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#waiting Read more...} */ readonly waiting: boolean | nullish; /** * The VideoLayer provides video content from on-demand and livestream feeds from an [GeoScene Video Server](https://enterprise.geosceneonline.cn/zh/video/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html Read more...} */ constructor(properties?: VideoLayerProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol} used for representing the center point of a video frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameCenterSymbol Read more...} */ get frameCenterSymbol(): SimpleMarkerSymbol; set frameCenterSymbol(value: SimpleMarkerSymbolProperties & { type: "simple-marker" }); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol} used for representing the coverage area of a video frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameOutlineSymbol Read more...} */ get frameOutlineSymbol(): SimpleFillSymbol; set frameOutlineSymbol(value: SimpleFillSymbolProperties & { type: "simple-fill" }); /** * The initial extent of the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#initialExtent Read more...} */ get initialExtent(): Extent | nullish; set initialExtent(value: ExtentProperties | nullish); /** * The playback information for the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#playbackInfo Read more...} */ get playbackInfo(): PlaybackInfo | nullish; set playbackInfo(value: PlaybackInfoProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the line of sight from the sensor to the center of the frame coverage area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorSightLineSymbol Read more...} */ get sensorSightLineSymbol(): SimpleLineSymbol; set sensorSightLineSymbol(value: SimpleLineSymbolProperties & { type: "simple-line" }); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html PictureMarkerSymbol} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the point position geometry of the video sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorSymbol Read more...} */ get sensorSymbol(): SimpleMarkerSymbol | PictureMarkerSymbol | CIMSymbol; set sensorSymbol(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (CIMSymbolProperties & { type: "cim" })); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the trailing line of travel of a moving video collection sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorTrailSymbol Read more...} */ get sensorTrailSymbol(): SimpleLineSymbol; set sensorTrailSymbol(value: SimpleLineSymbolProperties & { type: "simple-line" }); /** * The spatial reference of the video layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The telemetry display for the video layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#telemetryDisplay Read more...} */ get telemetryDisplay(): TelemetryDisplay | nullish; set telemetryDisplay(value: TelemetryDisplayProperties | nullish); /** * Pauses the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#pause Read more...} */ pause(): void; /** * Plays the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#play Read more...} */ play(): void; /** * Resets the video layer to its initial state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#reset Read more...} */ reset(): void; /** * Sets the current time, in seconds, of the video layer. * * @param timestamp The timestamp to set the video layer to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#setCurrentTime Read more...} */ setCurrentTime(timestamp: number): void; /** * Updates the telemetry color of all telemetry symbol elements to the provided color value. * * @param color The color to set the video telemetry symbol color to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#updateTelemetryColor Read more...} */ updateTelemetryColor(color: Color): void; } interface VideoLayerProperties extends LayerProperties, ScaleRangeLayerProperties, BlendLayerProperties { /** * Indicates if the video layer is configured to start playback when ready. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#autoplay Read more...} */ autoplay?: boolean; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The copyright information for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * The current time of the video layer in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#currentTime Read more...} */ currentTime?: number; /** * The description of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#description Read more...} */ description?: string | nullish; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol} used for representing the center point of a video frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameCenterSymbol Read more...} */ frameCenterSymbol?: SimpleMarkerSymbolProperties & { type: "simple-marker" }; /** * Provides filter functions that can be performed on the video frame to * achieve different visual effects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameEffect Read more...} */ frameEffect?: Effect | nullish; /** * The opacity of the video frame draped on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameOpacity Read more...} */ frameOpacity?: number; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol} used for representing the coverage area of a video frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#frameOutlineSymbol Read more...} */ frameOutlineSymbol?: SimpleFillSymbolProperties & { type: "simple-fill" }; /** * The initial extent of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#initialExtent Read more...} */ initialExtent?: ExtentProperties | nullish; /** * Indicates if the video layer should loop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#loop Read more...} */ loop?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Indicates if the video layer is muted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#muted Read more...} */ muted?: boolean; /** * The playback information for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#playbackInfo Read more...} */ playbackInfo?: PlaybackInfoProperties | nullish; /** * The playback rate of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#playbackRate Read more...} */ playbackRate?: number; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the line of sight from the sensor to the center of the frame coverage area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorSightLineSymbol Read more...} */ sensorSightLineSymbol?: SimpleLineSymbolProperties & { type: "simple-line" }; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html PictureMarkerSymbol} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the point position geometry of the video sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorSymbol Read more...} */ sensorSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (CIMSymbolProperties & { type: "cim" }); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the trailing line of travel of a moving video collection sensor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#sensorTrailSymbol Read more...} */ sensorTrailSymbol?: SimpleLineSymbolProperties & { type: "simple-line" }; /** * The spatial reference of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The playback start time in seconds since the beginning of the video. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#start Read more...} */ start?: number; /** * The telemetry display for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#telemetryDisplay Read more...} */ telemetryDisplay?: TelemetryDisplayProperties | nullish; /** * The URL to the REST endpoint of the video service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#url Read more...} */ url?: string | nullish; /** * The volume property sets or returns the audio volume of a video, from 0.0 * (silent) to 1.0 (loudest). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#volume Read more...} */ volume?: number; } /** * The **Codecs** is an object that represents the codecs used by the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#Codecs Read more...} */ export interface Codecs { audio: string; text: string; video: string; } export interface VideoLayerCapabilities { operations: VideoLayerCapabilitiesOperations; } export interface VideoLayerCapabilitiesOperations { supportsAppend: boolean; supportsCoverageQuery: boolean; supportsExportClip: boolean; supportsExportFrameset: boolean; supportsMensuration: boolean; supportsPreviews: boolean; supportsUpdate: boolean; } /** * The **VideoMetadataEntry** is an object that represents a metadata entry for the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#VideoMetadataEntry Read more...} */ export interface VideoMetadataEntry { name: string; tagId: number; value: any; } /** * The **VideoPoint** is an object that represents a point on the current video frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#VideoPoint Read more...} */ export interface VideoPoint { x: number; y: number; } /** * The **VideoServiceLayerInfo** defines layer information for video layers published within the same * video service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html#VideoServiceLayerInfo Read more...} */ export interface VideoServiceLayerInfo { layerId: number; posterUrl: string; sourceType: "ondemand" | "livestream"; title: string; type: "Video Layer"; } export interface ViewshedLayer extends Layer, OperationalLayer { } export class ViewshedLayer { /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; readonly type: "viewshed"; /** * The viewshed layer enables the creation and display of viewshed and view dome type of visibility analysis in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html Read more...} */ constructor(properties?: ViewshedLayerProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html ViewshedAnalysis} associated with the layer that stores the viewsheds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#source Read more...} */ get source(): ViewshedAnalysis; set source(value: ViewshedAnalysisProperties); static fromJSON(json: any): ViewshedLayer; } interface ViewshedLayerProperties extends LayerProperties, OperationalLayerProperties { /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-ViewshedAnalysis.html ViewshedAnalysis} associated with the layer that stores the viewsheds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#source Read more...} */ source?: ViewshedAnalysisProperties; } export interface VoxelDynamicSection extends JSONSupport, Clonable { } export class VoxelDynamicSection { /** * Whether or not the dynamic section is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#enabled Read more...} */ enabled: boolean; /** * The label for the dynamic section. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#label Read more...} */ label: string; /** * The orientation angle (in the degrees) of the dynamic section plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#orientation Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#point Read more...} */ point: number[]; /** * The tilt angle (in degrees) of the dynamic section plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#tilt Read more...} */ tilt: number; /** * The VoxelDynamicSection allows you to define the properties of an individual dynamic section. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html Read more...} */ constructor(properties?: VoxelDynamicSectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VoxelDynamicSection; } interface VoxelDynamicSectionProperties { /** * Whether or not the dynamic section is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#enabled Read more...} */ enabled?: boolean; /** * The label for the dynamic section. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#label Read more...} */ label?: string; /** * The orientation angle (in the degrees) of the dynamic section plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#orientation Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#point Read more...} */ point?: number[]; /** * The tilt angle (in degrees) of the dynamic section plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html#tilt Read more...} */ tilt?: number; } export interface VoxelSlice extends JSONSupport, Clonable { } export class VoxelSlice { /** * Whether or not the slice is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#enabled Read more...} */ enabled: boolean; /** * The label for the slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#label Read more...} */ label: string; /** * The orientation angle (in the degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#orientation Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#point Read more...} */ point: number[]; /** * The tilt angle (in degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#tilt Read more...} */ tilt: number; /** * The VoxelSlice allows you to define the properties of an individual slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html Read more...} */ constructor(properties?: VoxelSliceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VoxelSlice; } interface VoxelSliceProperties { /** * Whether or not the slice is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#enabled Read more...} */ enabled?: boolean; /** * The label for the slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#label Read more...} */ label?: string; /** * The orientation angle (in the degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#orientation Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#point Read more...} */ point?: number[]; /** * The tilt angle (in degrees) of the slice plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html#tilt Read more...} */ tilt?: number; } export interface VoxelTransferFunctionStyle extends JSONSupport, Clonable { } export class VoxelTransferFunctionStyle { /** * Defines the data range which will be rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#rangeFilter Read more...} */ rangeFilter: VoxelRangeFilter | nullish; /** * The data range to apply the color and alpha stops to, specified as [minimum, maximum] in the units of the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange Read more...} */ stretchRange: number[]; /** * The VoxelTransferFunctionStyle allows you to define how an individual continuous variable is rendered as a volume or as sections. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html Read more...} */ constructor(properties?: VoxelTransferFunctionStyleProperties); /** * A collection of colors and normalized positions which describe how to colorize the data values that are within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange stretchRange}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#colorStops Read more...} */ get colorStops(): Collection; set colorStops(value: CollectionProperties); /** * A collection of transparency values and normalized positions which describe how to apply transparency to the data values that are within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange stretchRange}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#opacityStops Read more...} */ get opacityStops(): Collection; set opacityStops(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange stretchRange}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#colorStops Read more...} */ colorStops?: CollectionProperties; /** * A collection of transparency values and normalized positions which describe how to apply transparency to the data values that are within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange stretchRange}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#opacityStops Read more...} */ opacityStops?: CollectionProperties; /** * Defines the data range which will be rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#rangeFilter Read more...} */ rangeFilter?: VoxelRangeFilter | nullish; /** * The data range to apply the color and alpha stops to, specified as [minimum, maximum] in the units of the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#stretchRange Read more...} */ stretchRange?: number[]; } /** * VoxelColorStop defines a color and a normalized position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#VoxelColorStop Read more...} */ export interface VoxelColorStop { color: Color; position: number; } /** * VoxelOpacityStop defines an opacity value and a normalized position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#VoxelOpacityStop Read more...} */ export interface VoxelOpacityStop { opacity: number; position: number; } /** * VoxelRangeFilter defines the data range which will be rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html#VoxelRangeFilter Read more...} */ export interface VoxelRangeFilter { enabled?: boolean; range: number[] | nullish; } /** * Describes a single variable in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html VoxelLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html Read more...} */ interface VoxelVariable { readonly description: string; readonly id: number; readonly name: string; readonly renderingFormat: VoxelVariableRenderingFormat; readonly unit: string; readonly volumeId: number; } export const VoxelVariable: VoxelVariable; export interface VoxelVariableRenderingFormat { continuity: "discrete" | "continuous" | nullish; hasNoData?: boolean; noData?: number; type: "Int8" | "UInt8" | "Int16" | "UInt16" | "Int32" | "UInt32" | "Float32" | "Float64" | nullish; } export interface VoxelVariableStyle extends JSONSupport, Clonable { } export class VoxelVariableStyle { /** * The variable label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#label Read more...} */ label: string; /** * Id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable} that the style applies to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#variableId Read more...} */ variableId: number; /** * The VoxelVariableStyle allows you to define how an individual variable is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html Read more...} */ constructor(properties?: VoxelVariableStyleProperties); /** * The collection of continuous variable isosurfaces. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#isosurfaces Read more...} */ get isosurfaces(): Collection; set isosurfaces(value: CollectionProperties); /** * The transferFunction describes how to render continuous variable volumes and sections. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#transferFunction Read more...} */ get transferFunction(): VoxelTransferFunctionStyle; set transferFunction(value: VoxelTransferFunctionStyleProperties); /** * The collection of unique values describes how to render discrete variable volumes and sections. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#uniqueValues Read more...} */ get uniqueValues(): Collection; set uniqueValues(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VoxelVariableStyle; } interface VoxelVariableStyleProperties { /** * The collection of continuous variable isosurfaces. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#isosurfaces Read more...} */ isosurfaces?: CollectionProperties; /** * The variable label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#label Read more...} */ label?: string; /** * The transferFunction describes how to render continuous variable volumes and sections. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#transferFunction Read more...} */ transferFunction?: VoxelTransferFunctionStyleProperties; /** * The collection of unique values describes how to render discrete variable volumes and sections. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#uniqueValues Read more...} */ uniqueValues?: CollectionProperties; /** * Id of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable} that the style applies to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#variableId Read more...} */ variableId?: number; } /** * VoxelIsosurface describes an isosurface value and how to render it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#VoxelIsosurface Read more...} */ export interface VoxelIsosurface { color: Color; value: number; enabled?: boolean; label?: string; colorLocked?: boolean; } /** * VoxelUniqueValue describes a particular voxel discrete value how to render it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html#VoxelUniqueValue Read more...} */ export interface VoxelUniqueValue { color: Color; value: number; enabled?: boolean; label?: string; } /** * The VoxelVolume exposes properties that describe the volume and methods to convert to and from voxel space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolume.html Read more...} */ interface VoxelVolume { readonly id: number; sizeInVoxels: number[]; volumeType: "xyz" | "xyzt" | "xyt"; /** * Convert a position in voxel space to the spatialReference of the layer. * * @param posInVoxelSpace The voxel space position to convert to layer space as as [x, y, z]. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolume.html#computeLayerSpaceLocation Read more...} */ computeLayerSpaceLocation(posInVoxelSpace: number[]): Point; /** * Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes. * * @param pos The XYZ position in the voxel layer spatial reference to convert to voxel space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolume.html#computeVoxelSpaceLocation Read more...} */ computeVoxelSpaceLocation(pos: Point): number[]; } export const VoxelVolume: VoxelVolume; export interface VoxelVolumeStyle extends JSONSupport, Clonable { } export class VoxelVolumeStyle { /** * The vertical exaggeration factor. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#verticalExaggeration Read more...} */ verticalExaggeration: number; /** * The vertical offset amount. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#verticalOffset Read more...} */ verticalOffset: number; /** * Id of the volume. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#volumeId Read more...} */ readonly volumeId: number; /** * The VolumeStyle allows you to define rendering properties that apply to the volume itself, such as vertical exaggeration and offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html Read more...} */ constructor(properties?: VoxelVolumeStyleProperties); /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html VoxelDynamicSection}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#dynamicSections Read more...} */ get dynamicSections(): Collection; set dynamicSections(value: CollectionProperties); /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html VoxelSlice}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#slices Read more...} */ get slices(): Collection; set slices(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VoxelVolumeStyle; } interface VoxelVolumeStyleProperties { /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelDynamicSection.html VoxelDynamicSection}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#dynamicSections Read more...} */ dynamicSections?: CollectionProperties; /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelSlice.html VoxelSlice}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#slices Read more...} */ slices?: CollectionProperties; /** * The vertical exaggeration factor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#verticalExaggeration Read more...} */ verticalExaggeration?: number; /** * The vertical offset amount. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html#verticalOffset Read more...} */ verticalOffset?: number; } export interface VoxelLayer extends Layer, SceneService, PortalLayer, ScaleRangeLayer, CustomParametersMixin, APIKeyMixin, OperationalLayer { } export class VoxelLayer { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#apiKey Read more...} */ declare apiKey: APIKeyMixin["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#copyright Read more...} */ declare copyright: SceneService["copyright"]; /** * The variable that is being displayed. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#currentVariableId Read more...} */ currentVariableId: number; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#customParameters Read more...} */ declare customParameters: CustomParametersMixin["customParameters"]; /** * Controls whether or not to globally disable all dynamic sections in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html VoxelVolumeStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableDynamicSections Read more...} */ enableDynamicSections: boolean; /** * Controls whether or not to globally disable all isosurfaces in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html VoxelVariableStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableIsosurfaces Read more...} */ enableIsosurfaces: boolean; /** * Controls whether or not to globally disable all slices in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html VoxelVolumeStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableSlices Read more...} */ enableSlices: boolean; /** * A complete list of fields that consists of fixed voxel fields and the voxel variables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#fields Read more...} */ readonly fields: Field[]; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#layerId Read more...} */ declare layerId: SceneService["layerId"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when voxels in the layer are clicked. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Current rendering mode for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html VoxelLayer}. * * @default "volume" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#renderMode Read more...} */ renderMode: "volume" | "surfaces"; /** * TimeInfo provides information such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#stops stops} the layer has data for * and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#timeInfo Read more...} */ readonly timeInfo: TimeInfo | nullish; readonly type: "voxel"; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#url Read more...} */ declare url: SceneService["url"]; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#useViewTime Read more...} */ useViewTime: boolean; /** * The collection of variables that the VoxelLayer has data for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#variables Read more...} */ readonly variables: Collection; /** * The version of the scene service specification used for this service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#version Read more...} */ declare readonly version: SceneService["version"]; /** * The collection of volumes that the VoxelLayer has variables for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#volumes Read more...} */ readonly volumes: Collection; /** * A voxel layer represents multidimensional volumetric data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html Read more...} */ constructor(properties?: VoxelLayerProperties); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * The collection of variable styles, containing exactly one {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html VoxelVariableStyle} for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#variableStyles Read more...} */ get variableStyles(): Collection; set variableStyles(value: CollectionProperties); /** * The collection of volume styles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#volumeStyles Read more...} */ get volumeStyles(): Collection; set volumeStyles(value: CollectionProperties); /** * Creates a default popup template for the layer, populated with the default voxel fields and a field for each variable in the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} for a given value for the continuous {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable} identified by variableId using * the variable's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelTransferFunctionStyle.html VoxelTransferFunctionStyle}. * * @param variableId Voxel variable id for a continuous variable. * @param dataValue The continuous data value to get a color for. * @param applyOpacityStops Whether or not to apply the opacity stops to the returned color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getColorForContinuousDataValue Read more...} */ getColorForContinuousDataValue(variableId: number, dataValue: number, applyOpacityStops: boolean): Color | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable} based on an id. * * @param variableId Voxel variable id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getVariable Read more...} */ getVariable(variableId: number | nullish): VoxelVariable | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html VoxelVariableStyle} based on an id. * * @param variableId Voxel variable id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getVariableStyle Read more...} */ getVariableStyle(variableId: number | nullish): VoxelVariableStyle | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolume.html VoxelVolume} based on the id of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable}. * * @param variableId Voxel variable id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getVolume Read more...} */ getVolume(variableId: number | nullish): VoxelVolume | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html VoxelVolumeStyle} based on the id of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable}. * * @param variableId Voxel variable id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#getVolumeStyle Read more...} */ getVolumeStyle(variableId: number | nullish): VoxelVolumeStyle | nullish; static fromJSON(json: any): VoxelLayer; } interface VoxelLayerProperties extends LayerProperties, SceneServiceProperties, PortalLayerProperties, ScaleRangeLayerProperties, CustomParametersMixinProperties, APIKeyMixinProperties, OperationalLayerProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#apiKey Read more...} */ apiKey?: APIKeyMixinProperties["apiKey"]; /** * The copyright text as defined by the scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#copyright Read more...} */ copyright?: SceneServiceProperties["copyright"]; /** * The variable that is being displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#currentVariableId Read more...} */ currentVariableId?: number; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#customParameters Read more...} */ customParameters?: CustomParametersMixinProperties["customParameters"]; /** * Controls whether or not to globally disable all dynamic sections in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html VoxelVolumeStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableDynamicSections Read more...} */ enableDynamicSections?: boolean; /** * Controls whether or not to globally disable all isosurfaces in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html VoxelVariableStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableIsosurfaces Read more...} */ enableIsosurfaces?: boolean; /** * Controls whether or not to globally disable all slices in the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVolumeStyle.html VoxelVolumeStyle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#enableSlices Read more...} */ enableSlices?: boolean; /** * The layer ID, or layer index, of a Scene Service layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#layerId Read more...} */ layerId?: SceneServiceProperties["layerId"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when voxels in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Current rendering mode for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html VoxelLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#renderMode Read more...} */ renderMode?: "volume" | "surfaces"; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL of the REST endpoint of the layer or scene service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#url Read more...} */ url?: SceneServiceProperties["url"]; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#useViewTime Read more...} */ useViewTime?: boolean; /** * The collection of variable styles, containing exactly one {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariableStyle.html VoxelVariableStyle} for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-voxel-VoxelVariable.html VoxelVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#variableStyles Read more...} */ variableStyles?: CollectionProperties; /** * The collection of volume styles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VoxelLayer.html#volumeStyles Read more...} */ volumeStyles?: CollectionProperties; } export interface WCSLayer extends Layer, BlendLayer, ImageryTileMixin, OperationalLayer, PortalLayer, ScaleRangeLayer { } export class WCSLayer { /** * Defines a band combination using 0-based band indexes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#bandIds Read more...} */ declare bandIds: ImageryTileMixin["bandIds"]; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#copyright Read more...} */ declare copyright: ImageryTileMixin["copyright"]; /** * The coverage identifier for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#coverageId Read more...} */ coverageId: string; /** * Coverage information retrieved from the WCS Server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#coverageInfo Read more...} */ coverageInfo: CoverageInfo; /** * Use this property to append custom parameters to all WCS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#customParameters Read more...} */ customParameters: any; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#effect Read more...} */ effect: Effect | nullish; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#interpolation Read more...} */ declare interpolation: ImageryTileMixin["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#legendEnabled Read more...} */ declare legendEnabled: ImageryTileMixin["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The multidimensional definitions associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#multidimensionalDefinition Read more...} */ declare multidimensionalDefinition: ImageryTileMixin["multidimensionalDefinition"]; /** * The specified noData value applies when neither the service metadata nor the coverage contains noData information. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#noData Read more...} */ noData: number | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * An array of raster fields in the layer that consists of service pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#rasterFields Read more...} */ readonly rasterFields: Field[]; /** * Raster information retrieved from tiled imagery data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#serviceRasterInfo Read more...} */ declare readonly serviceRasterInfo: ImageryTileMixin["serviceRasterInfo"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#spatialReference Read more...} */ declare readonly spatialReference: ImageryTileMixin["spatialReference"]; readonly type: "wcs"; /** * The URL of the WCS service endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#url Read more...} */ url: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#useViewTime Read more...} */ declare useViewTime: ImageryTileMixin["useViewTime"]; /** * The version of Web Coverage Service currently being used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#version Read more...} */ version: string; /** * WCS presents raster data from a [OGC Web Coverage Service](https://www.ogc.org/standards/wcs). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html Read more...} */ constructor(properties?: WCSLayerProperties); /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#multidimensionalSubset Read more...} */ get multidimensionalSubset(): MultidimensionalSubset | nullish; set multidimensionalSubset(value: MultidimensionalSubsetProperties | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#renderer Read more...} */ get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer | nullish; set renderer(value: | (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" }) | nullish); /** * The layer's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Creates a default popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Fetches pixels for a given extent. * * @param extent The extent of the image to export. * @param width The width of the image in pixels. * @param height The height of the image in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#fetchPixels Read more...} */ fetchPixels(extent: Extent, width: number, height: number, options?: ImageryTileMixinFetchPixelsOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#getSamples Read more...} */ getSamples(parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Identify pixel values at a given location. * * @param point Input point that defines the location to be identified. * @param options Optional settings for the identify request. At version 4.25, the `transposedVariableName` was added to get pixel values from specific dimensional definitions if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer} references a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterInfo.html#hasMultidimensionalTranspose transposed multidimensional} image service. Set the `transposedVariableName` and `multidimensionalDefinition` get pixel values for the specified dimensional definitions from a transposed multidimensional service. If `multidimensionalDefinition` is not specified, pixel values will be returned from all the dimensional slices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#identify Read more...} */ identify(point: PointProperties, options?: RasterIdentifyOptions): Promise; /** * Saves the layer to its existing portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} * authenticated within the user's current session. * * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#save Read more...} */ save(options?: WCSLayerSaveOptions): Promise; /** * Saves the layer to a new portal item in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal} authenticated within the user's current session. * * @param portalItem The portal item to which the layer will be saved. * @param options Various options for saving the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: WCSLayerSaveAsOptions): Promise; static fromJSON(json: any): WCSLayer; } interface WCSLayerProperties extends LayerProperties, BlendLayerProperties, ImageryTileMixinProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties { /** * Defines a band combination using 0-based band indexes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#bandIds Read more...} */ bandIds?: ImageryTileMixinProperties["bandIds"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The copyright text as defined by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#copyright Read more...} */ copyright?: ImageryTileMixinProperties["copyright"]; /** * The coverage identifier for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#coverageId Read more...} */ coverageId?: string; /** * Coverage information retrieved from the WCS Server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#coverageInfo Read more...} */ coverageInfo?: CoverageInfo; /** * Use this property to append custom parameters to all WCS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#customParameters Read more...} */ customParameters?: any; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#interpolation Read more...} */ interpolation?: ImageryTileMixinProperties["interpolation"]; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#legendEnabled Read more...} */ legendEnabled?: ImageryTileMixinProperties["legendEnabled"]; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The multidimensional definitions associated with the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#multidimensionalDefinition Read more...} */ multidimensionalDefinition?: ImageryTileMixinProperties["multidimensionalDefinition"]; /** * Represents a multidimensional subset of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#multidimensionalSubset Read more...} */ multidimensionalSubset?: MultidimensionalSubsetProperties | nullish; /** * The specified noData value applies when neither the service metadata nor the coverage contains noData information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#noData Read more...} */ noData?: number | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#renderer Read more...} */ 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" }) | nullish; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL of the WCS service endpoint of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#url Read more...} */ url?: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#useViewTime Read more...} */ useViewTime?: ImageryTileMixinProperties["useViewTime"]; /** * The version of Web Coverage Service currently being used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#version Read more...} */ version?: string; } /** * Coverage description for WCS service version 1.0.0. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#CoverageDescriptionV100 Read more...} */ export interface CoverageDescriptionV100 { name: string; label: string; description: string; supportedFormats: string[]; supportedInterpolations: string[]; supportedCRSs: CoverageDescriptionV100SupportedCRSs; lonLatEnvelope: Extent; rangeSet: CoverageDescriptionV100RangeSet[]; domainSet: CoverageDescriptionV100DomainSet; version: "1.0"; } /** * Coverage description for WCS service version 1.1.0. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#CoverageDescriptionV110 Read more...} */ export interface CoverageDescriptionV110 { title: string; abstract: string; identifier: string; supportedFormats: string[]; supportedCRSs: string[]; domain: CoverageDescriptionV110Domain; range: CoverageDescriptionV110Range[]; resolution: CoverageDescriptionV110Resolution; metadata?: string; version: "1.1"; } /** * Coverage description for WCS service version 2.0.1. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#CoverageDescriptionV201 Read more...} */ export interface CoverageDescriptionV201 { coverageId: string; boundedBy: CoverageDescriptionV201BoundedBy; domainSet: CoverageDescriptionV201DomainSet; rangeType: CoverageDescriptionV201RangeType[][]; serviceParameters: any; resolution: CoverageDescriptionV201Resolution; coverageFunction?: any | nullish; extension?: string | nullish; eoMetadata?: CoverageDescriptionV201EoMetadata | nullish; version: "2.0"; } /** * Coverage information associated with a WCS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#CoverageInfo Read more...} */ export interface CoverageInfo { id: string; title: string; description: string; lonLatEnvelope?: Extent | nullish; bandNames: string[]; rasterInfo: RasterInfo; supportedFormats: string[]; supportedInterpolations?: ("nearest" | "bilinear" | "cubic" | "majority")[] | undefined; coverageDescription: CoverageDescriptionV100 | CoverageDescriptionV110 | CoverageDescriptionV201; version: "1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1"; useEPSGAxis: boolean; } /** * Temporal domain or extent of a coverage. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html#TemporalDomain Read more...} */ export interface TemporalDomain { begin: Date; end: Date; values?: Date[] | nullish; resolution?: number | nullish; units?: any | nullish; } export interface WCSLayerSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface WCSLayerSaveOptions { ignoreUnsupported?: boolean; } export interface CoverageDescriptionV100DomainSet { spatialDomain: CoverageDescriptionV100DomainSetSpatialDomain; temporalDomain?: TemporalDomain | nullish; } export interface CoverageDescriptionV100DomainSetSpatialDomain { envelope: Extent; columns: number; rows: number; offset: CoverageDescriptionV100DomainSetSpatialDomainOffset; origin: CoverageDescriptionV100DomainSetSpatialDomainOrigin; } export interface CoverageDescriptionV100DomainSetSpatialDomainOffset { x: number; y: any; } export interface CoverageDescriptionV100DomainSetSpatialDomainOrigin { x: number; y: any; } export interface CoverageDescriptionV100RangeSet { name: string; label: string; nullValues?: number[] | nullish; axis: CoverageDescriptionV100RangeSetAxis[]; } export interface CoverageDescriptionV100RangeSetAxis { name: string; label: string; values: string[]; } export interface CoverageDescriptionV100SupportedCRSs { requestResponseCRSs: string[]; nativeCRSs: string[]; } export interface CoverageDescriptionV110Domain { spatialDomain: CoverageDescriptionV110DomainSpatialDomain; temporalDomain: TemporalDomain | nullish; } export interface CoverageDescriptionV110DomainSpatialDomain { envelope: Extent; columns: number; rows: number; offset: CoverageDescriptionV110DomainSpatialDomainOffset; origin: CoverageDescriptionV110DomainSpatialDomainOrigin; gridBaseCRS: string; useEPSGAxis: boolean; } export interface CoverageDescriptionV110DomainSpatialDomainOffset { x: number; y: any; } export interface CoverageDescriptionV110DomainSpatialDomainOrigin { x: number; y: any; } export interface CoverageDescriptionV110Range { identifier: string; description?: string | nullish; definition: string; abstract?: string | nullish; title?: string | nullish; supportedInterpolations: string[]; nullValues: number[]; axis: CoverageDescriptionV110RangeAxis[]; } export interface CoverageDescriptionV110RangeAxis { identifier: string; uom: string; dataType: string; values: string[]; bandNoDataValues?: number[]; } export interface CoverageDescriptionV110Resolution { x: any; y: any; } export interface CoverageDescriptionV201BoundedBy { envelope: Extent; axisLabels: string[]; uomLabels: string[] | nullish; envelopeAllDims: CoverageDescriptionV201BoundedByEnvelopeAllDims; beginPosition?: Date | nullish; endPosition?: Date | nullish; isEastFirst: boolean; } export interface CoverageDescriptionV201BoundedByEnvelopeAllDims { mins: number[]; maxs: number[]; } export interface CoverageDescriptionV201DomainSet { columns: number; rows: number; origin: number[]; offset: number[]; resolution: CoverageDescriptionV201DomainSetResolution; gridSamples: number[]; axisLabels: string[]; hasSameAxisLabelsAsBoundedBy: boolean; } export interface CoverageDescriptionV201DomainSetResolution { x: number; y: number; } export interface CoverageDescriptionV201EoMetadata { observation: CoverageDescriptionV201EoMetadataObservation; } export interface CoverageDescriptionV201EoMetadataObservation { phenomenonTime?: TemporalDomain | nullish; resultTime?: TemporalDomain | nullish; footprint?: Polygon | nullish; identifier: string; acquisitionType?: string | nullish; status?: string | nullish; } export interface CoverageDescriptionV201RangeType { name: string; description?: string | nullish; uom: string; nilValue?: number | nullish; allowedValues?: number[] | nullish; } export interface CoverageDescriptionV201Resolution { x: number; y: number; } export interface WebTileLayer extends Layer, ScaleRangeLayer, RefreshableLayer, PortalLayer, BlendLayer, OperationalLayer { } export class WebTileLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * The attribution information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#copyright Read more...} */ copyright: string; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * The spatial reference of the layer. * * @default SpatialReference.WebMercator // wkid: 3857 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference; /** * A string of subDomain names where tiles are served to speed up tile retrieval. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#subDomains Read more...} */ subDomains: string[] | nullish; /** * The list of tile server urls for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#tileServers Read more...} */ readonly tileServers: string[] | nullish; /** * For {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html WebTileLayer} the type is `web-tile`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#type Read more...} */ readonly type: "web-tile" | "open-street-map"; /** * The url template is a string that specifies the URL of the hosted tile images to load. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#urlTemplate Read more...} */ urlTemplate: string | nullish; /** * WebTileLayer provides a simple way to add non-GeoScene Server map tiles as a layer to a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html Read more...} */ constructor(properties?: WebTileLayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#tileInfo Read more...} */ get tileInfo(): TileInfo; set tileInfo(value: TileInfoProperties); /** * This method fetches a tile for the given level, row and column present in the view. * * @param level Level of detail of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param row The row(y) position of the tile fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param col The column(x) position of the tile to fetch. This value is provided by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView}. * @param options Optional settings for the tile request. The options have the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#fetchTile Read more...} */ 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. * * @param level The requested tile's level. * @param row The requested tile's row. * @param col The requested tile's column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#getTileUrl Read more...} */ getTileUrl(level: number, row: number, col: number): string; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#refresh Read more...} */ refresh(): void; on(name: "refresh", eventHandler: WebTileLayerRefreshEventHandler): IHandle; on(name: "layerview-create", eventHandler: WebTileLayerLayerviewCreateEventHandler): IHandle; on(name: "layerview-create-error", eventHandler: WebTileLayerLayerviewCreateErrorEventHandler): IHandle; on(name: "layerview-destroy", eventHandler: WebTileLayerLayerviewDestroyEventHandler): IHandle; static fromJSON(json: any): WebTileLayer; } interface WebTileLayerProperties extends LayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, PortalLayerProperties, BlendLayerProperties, OperationalLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * The attribution information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#copyright Read more...} */ copyright?: string; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * A string of subDomain names where tiles are served to speed up tile retrieval. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#subDomains Read more...} */ subDomains?: string[] | nullish; /** * The tiling scheme information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#tileInfo Read more...} */ tileInfo?: TileInfoProperties; /** * The url template is a string that specifies the URL of the hosted tile images to load. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WebTileLayer.html#urlTemplate Read more...} */ urlTemplate?: string | nullish; } export interface WebTileLayerLayerviewCreateErrorEvent { error: Error; view: View; } export interface WebTileLayerLayerviewCreateEvent { layerView: LayerView; view: View; } export interface WebTileLayerLayerviewDestroyEvent { layerView: LayerView; view: View; } export interface WebTileLayerRefreshEvent { dataChanged: boolean; } export interface WebTileLayerFetchTileOptions { signal?: AbortSignal | nullish; } export interface WFSLayer extends Layer, BlendLayer, DisplayFilteredLayer, FeatureEffectLayer, FeatureReductionLayer, OperationalLayer, OrderedLayer, PortalLayer, RefreshableLayer, ScaleRangeLayer, TrackableLayer { } export class WFSLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#capabilities Read more...} */ readonly capabilities: Capabilities | nullish; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#copyright Read more...} */ copyright: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#customParameters Read more...} */ customParameters: any | nullish; /** * The time zone that dates are stored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#dateFieldsTimeZone Read more...} */ readonly dateFieldsTimeZone: string | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterEnabled Read more...} */ declare displayFilterEnabled: DisplayFilteredLayer["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterInfo Read more...} */ declare displayFilterInfo: DisplayFilteredLayer["displayFilterInfo"]; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#effect Read more...} */ effect: Effect | nullish; /** * A convenient property that can be used to make case-insensitive lookups for a field by name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fieldsIndex Read more...} */ readonly fieldsIndex: FieldsIndex; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#geometryType Read more...} */ geometryType: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * Indicates whether to display labels for this layer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#labelsVisible Read more...} */ labelsVisible: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum number of queries allowed to fetch the whole dataset from the service. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxPageCount Read more...} */ maxPageCount: number; /** * The maximum number of features that can be returned in a single request. * * @default 3000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxRecordCount Read more...} */ maxRecordCount: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * The name of the layer in the WFS service to display, excluding the namespace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#name Read more...} */ name: string | nullish; /** * The namespace URI for the layer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#namespaceUri Read more...} */ namespaceUri: string | nullish; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#objectIdField Read more...} */ objectIdField: string; /** * An array of field names from the WFS layer to include with each feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#outFields Read more...} */ outFields: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled: boolean; readonly type: "wfs"; /** * The url to the WFS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#url Read more...} */ url: string | nullish; /** * WFS service information about the available layers and operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#wfsCapabilities Read more...} */ wfsCapabilities: WFSCapabilities; /** * The WFSLayer is used to create a layer based on an [OGC Web Feature Service](https://www.ogc.org/standards/wfs) (WFS). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html Read more...} */ constructor(properties?: WFSLayerProperties); /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#elevationInfo Read more...} */ get elevationInfo(): WFSLayerElevationInfo | nullish; set elevationInfo(value: WFSLayerElevationInfoProperties | nullish); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#featureReduction Read more...} */ get featureReduction(): FeatureReductionBinning | FeatureReductionCluster | FeatureReductionSelection | nullish; set featureReduction(value: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish); /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#labelingInfo Read more...} */ get labelingInfo(): LabelClass[] | nullish; set labelingInfo(value: LabelClassProperties[] | nullish); /** * Determines the order in which features are drawn in the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#orderBy Read more...} */ get orderBy(): OrderByInfo[] | nullish; set orderBy(value: OrderByInfoProperties[] | nullish); /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#renderer Read more...} */ get renderer(): RendererUnion; set renderer(value: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" })); /** * The spatial reference of the layer. * * @default SpatialReference.WGS84 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#trackInfo Read more...} */ get trackInfo(): TrackInfo | nullish; set trackInfo(value: TrackInfoProperties | nullish); /** * Creates a popup template for the layer, populated with all the fields of the layer. * * @param options Options for creating the popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#createPopupTemplate Read more...} */ createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates query parameter object that can be used to fetch features that satisfy the layer's configurations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#createQuery Read more...} */ createQuery(): Query; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} instance for a field name (case-insensitive). * * @param fieldName Name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#getField Read more...} */ getField(fieldName: string): Field | nullish; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Domain.html Domain} associated with the given field name. * * @param fieldName Name of the field. * @param options An object specifying additional options. See the object specification table below for the required properties of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#getFieldDomain Read more...} */ getFieldDomain(fieldName: string, options?: WFSLayerGetFieldDomainOptions): Domain | nullish; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against a WFSLayer, which groups features into bins based on ranges in numeric or date fields, and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: WFSLayerQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties | null, options?: WFSLayerQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and * returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties | null, options?: WFSLayerQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties | null, options?: WFSLayerQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer and returns an * array of Object IDs for features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties | null, options?: WFSLayerQueryObjectIdsOptions): Promise; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#refresh Read more...} */ refresh(): void; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#getWFSLayerInfo wfsUtils.getWFSLayerInfo()}. * * @param layerInfo The layer info object created from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ogc-wfsUtils.html#getWFSLayerInfo wfsUtils.getWFSLayerInfo()} * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fromWFSLayerInfo Read more...} */ static fromWFSLayerInfo(layerInfo: WFSLayerInfo): WFSLayer; static fromJSON(json: any): WFSLayer; } interface WFSLayerProperties extends LayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureEffectLayerProperties, FeatureReductionLayerProperties, OperationalLayerProperties, OrderedLayerProperties, PortalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TrackableLayerProperties { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * A list of custom parameters appended to the URL of all resources fetched by the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#customParameters Read more...} */ customParameters?: any | nullish; /** * The SQL where clause used to filter features on the client. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates whether the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterInfo displayFilterInfo} is applied when rendering the layer in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: DisplayFilteredLayerProperties["displayFilterEnabled"]; /** * Information related to a display filter associated with a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#displayFilterInfo Read more...} */ displayFilterInfo?: DisplayFilteredLayerProperties["displayFilterInfo"]; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * Specifies how features are placed on the vertical axis (z). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#elevationInfo Read more...} */ elevationInfo?: WFSLayerElevationInfoProperties | nullish; /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * Configures the method for reducing the number of features in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#featureReduction Read more...} */ featureReduction?: | (FeatureReductionBinningProperties & { type: "binning" }) | (FeatureReductionClusterProperties & { type: "cluster" }) | (FeatureReductionSelectionProperties & { type: "selection" }) | nullish; /** * An array of fields in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#geometryType Read more...} */ geometryType?: "point" | "polygon" | "polyline" | "multipoint" | nullish; /** * The label definition for this layer, specified as an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-LabelClass.html LabelClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#labelingInfo Read more...} */ labelingInfo?: LabelClassProperties[] | nullish; /** * Indicates whether to display labels for this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#labelsVisible Read more...} */ labelsVisible?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum number of queries allowed to fetch the whole dataset from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxPageCount Read more...} */ maxPageCount?: number; /** * The maximum number of features that can be returned in a single request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxRecordCount Read more...} */ maxRecordCount?: number; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * The name of the layer in the WFS service to display, excluding the namespace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#name Read more...} */ name?: string | nullish; /** * The namespace URI for the layer name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#namespaceUri Read more...} */ namespaceUri?: string | nullish; /** * The name of an `oid` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#fields field} containing * a unique value or identifier for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#objectIdField Read more...} */ objectIdField?: string; /** * Determines the order in which features are drawn in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#orderBy Read more...} */ orderBy?: OrderByInfoProperties[] | nullish; /** * An array of field names from the WFS layer to include with each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * Indicates whether to display popups when features in the layer are clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * The popup template for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The renderer assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#renderer Read more...} */ renderer?: | (HeatmapRendererProperties & { type: "heatmap" }) | (SimpleRendererProperties & { type: "simple" }) | (ClassBreaksRendererProperties & { type: "class-breaks" }) | (UniqueValueRendererProperties & { type: "unique-value" }) | (DotDensityRendererProperties & { type: "dot-density" }) | (DictionaryRendererProperties & { type: "dictionary" }) | (PieChartRendererProperties & { type: "pie-chart" }); /** * Apply perspective scaling to screen-size point symbols in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#screenSizePerspectiveEnabled Read more...} */ screenSizePerspectiveEnabled?: boolean; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * Allows you to render track data for a layer, including a track line, previous observations, and latest observations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#trackInfo Read more...} */ trackInfo?: TrackInfoProperties | nullish; /** * The url to the WFS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#url Read more...} */ url?: string | nullish; /** * WFS service information about the available layers and operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html#wfsCapabilities Read more...} */ 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 WFSLayerElevationInfoProperties { mode?: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset?: number | nullish; featureExpressionInfo?: WFSLayerElevationInfoFeatureExpressionInfoProperties | nullish; unit?: ElevationUnit | nullish; } export interface WFSLayerElevationInfo extends AnonymousAccessor { get featureExpressionInfo(): WFSLayerElevationInfoFeatureExpressionInfo | nullish; set featureExpressionInfo(value: WFSLayerElevationInfoFeatureExpressionInfoProperties | nullish); mode: "on-the-ground" | "relative-to-ground" | "absolute-height" | "relative-to-scene"; offset: number | nullish; unit: ElevationUnit | nullish; } export interface WFSLayerElevationInfoFeatureExpressionInfoProperties { title?: string; expression?: string; } export interface WFSLayerElevationInfoFeatureExpressionInfo extends AnonymousAccessor { title: string; expression: string; } export interface WFSLayerGetFieldDomainOptions { feature: Graphic; } export interface WFSLayerQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface WFSLayerQueryExtentOptions { signal?: AbortSignal | nullish; } export interface WFSLayerQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface WFSLayerQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface WFSLayerQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface WMSLayer extends Layer, BlendLayer, OperationalLayer, PortalLayer, ScaleRangeLayer, RefreshableLayer { } export class WMSLayer { /** * A flattened collection of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer}s based on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#sublayers `sublayers`} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#allSublayers Read more...} */ readonly allSublayers: Collection; /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Copyright information for the WMS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#copyright Read more...} */ copyright: string | nullish; /** * Use this to append different custom parameters to the WMS map requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#customLayerParameters Read more...} */ customLayerParameters: any | nullish; /** * Use this to append custom parameters to all WMS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#customParameters Read more...} */ customParameters: any | nullish; /** * Description for the WMS layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#description Read more...} */ description: string | nullish; /** * An array of time, elevation and other dimensions for the root layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#dimensions Read more...} */ readonly dimensions: (TimeDimension | ElevationDimension | GenericDimension)[] | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The MIME type that will be requested by popups. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#featureInfoFormat Read more...} */ featureInfoFormat: "text/html" | "text/plain" | nullish; /** * This property lists all available MIME-types that can be used with the WMS service's _GetFeatureInfo_ request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#featureInfoFormats Read more...} */ readonly featureInfoFormats: string[] | nullish; /** * The URL for the WMS GetFeatureInfo call. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#featureInfoUrl Read more...} */ featureInfoUrl: string | nullish; /** * Function to override the default popup behavior of `WMSLayer`. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#fetchFeatureInfoFunction Read more...} */ fetchFeatureInfoFunction: FetchFeatureInfoFunction | nullish; /** * The map image format (MIME type) to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageFormat Read more...} */ imageFormat: string | nullish; /** * Indicates the maximum height of the image exported by the service. * * @default 2048 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageMaxHeight Read more...} */ imageMaxHeight: number; /** * Indicates the maximum width of the image exported by the service. * * @default 2048 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageMaxWidth Read more...} */ imageMaxWidth: number; /** * Indicates whether the background of the image exported by the service is transparent. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageTransparency Read more...} */ imageTransparency: boolean; /** * Indicates whether the layer will be included in the legend. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#legendEnabled Read more...} */ legendEnabled: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#spatialReferences Read more...} */ spatialReferences: number[] | nullish; readonly type: "wms"; /** * The URL of the WMS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#url Read more...} */ url: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#useViewTime Read more...} */ useViewTime: boolean; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#version Read more...} */ version: string; /** * The WMSLayer is used to create layers based on OGC Web Map Services (WMS). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html Read more...} */ constructor(properties?: WMSLayerProperties); /** * All bounding boxes defined for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#fullExtents Read more...} */ get fullExtents(): Extent[] | nullish; set fullExtents(value: ExtentProperties[] | nullish); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * A subset of the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer}s that will be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#sublayers Read more...} */ get sublayers(): Collection; set sublayers(value: CollectionProperties); /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeInfo Read more...} */ get timeInfo(): TimeInfo | nullish; set timeInfo(value: TimeInfoProperties | nullish); /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeOffset Read more...} */ get timeOffset(): TimeInterval | nullish; set timeOffset(value: TimeIntervalProperties | nullish); /** * Fetching the WMS image. * * @param extent The extent of the view. * @param width The width of the view in pixels. * @param height The height of the view in pixels. * @param options The parameter options is an object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#fetchImage Read more...} */ fetchImage(extent: Extent, width: number, height: number, options?: WMSLayerFetchImageOptions): Promise; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer} based on the given sublayer id. * * @param id The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#id id} of the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#findSublayerById Read more...} */ findSublayerById(id: number): WMSSublayer | nullish; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer} based on the given sublayer name. * * @param name The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html#name name} of the WMS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#findSublayerByName Read more...} */ findSublayerByName(name: string): WMSSublayer | nullish; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#refresh Read more...} */ refresh(): void; 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 { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the WMS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#copyright Read more...} */ copyright?: string | nullish; /** * Use this to append different custom parameters to the WMS map requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#customLayerParameters Read more...} */ customLayerParameters?: any | nullish; /** * Use this to append custom parameters to all WMS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#customParameters Read more...} */ customParameters?: any | nullish; /** * Description for the WMS layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#description Read more...} */ description?: string | nullish; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The MIME type that will be requested by popups. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#featureInfoFormat Read more...} */ featureInfoFormat?: "text/html" | "text/plain" | nullish; /** * The URL for the WMS GetFeatureInfo call. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#featureInfoUrl Read more...} */ featureInfoUrl?: string | nullish; /** * Function to override the default popup behavior of `WMSLayer`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#fetchFeatureInfoFunction Read more...} */ fetchFeatureInfoFunction?: FetchFeatureInfoFunction | nullish; /** * All bounding boxes defined for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#fullExtents Read more...} */ fullExtents?: ExtentProperties[] | nullish; /** * The map image format (MIME type) to request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageFormat Read more...} */ imageFormat?: string | nullish; /** * Indicates the maximum height of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageMaxHeight Read more...} */ imageMaxHeight?: number; /** * Indicates the maximum width of the image exported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageMaxWidth Read more...} */ imageMaxWidth?: number; /** * Indicates whether the background of the image exported by the service is transparent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#imageTransparency Read more...} */ imageTransparency?: boolean; /** * Indicates whether the layer will be included in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#legendEnabled Read more...} */ legendEnabled?: boolean; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The spatial reference of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * List of spatialReference well known ids derived from the CRS elements of the first layer in the GetCapabilities request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#spatialReferences Read more...} */ spatialReferences?: number[] | nullish; /** * A subset of the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMSSublayer.html WMSSublayer}s that will be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#sublayers Read more...} */ sublayers?: CollectionProperties; /** * The layer's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * TimeInfo provides information such as date fields that store * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#startField start} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#endField end} time * for each feature and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#fullTimeExtent fullTimeExtent} * for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeInfo Read more...} */ timeInfo?: TimeInfoProperties | nullish; /** * A temporary offset of the time data based on a certain {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#timeOffset Read more...} */ timeOffset?: TimeIntervalProperties | nullish; /** * The URL of the WMS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#url Read more...} */ url?: string; /** * Determines if the layer will update its temporal data based on the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#useViewTime Read more...} */ useViewTime?: boolean; /** * Version of the [WMS specification](http://www.opengeospatial.org/standards/wms) to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMSLayer.html#version Read more...} */ 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 { pixelRatio?: number; rotation?: number; timeExent?: any; signal?: AbortSignal | nullish; } export interface WMTSLayer extends Layer, OperationalLayer, PortalLayer, ScaleRangeLayer, RefreshableLayer, BlendLayer { } export class WMTSLayer { /** * 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#blendMode Read more...} */ declare blendMode: BlendLayer["blendMode"]; /** * Copyright information for the WMTS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#copyright Read more...} */ copyright: string; /** * Use this to append different custom parameters to the WMTS tile requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#customLayerParameters Read more...} */ customLayerParameters: any | nullish; /** * Use this to append custom parameters to all WMTS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#customParameters Read more...} */ customParameters: any | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#effect Read more...} */ effect: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#maxScale Read more...} */ declare maxScale: ScaleRangeLayer["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#minScale Read more...} */ declare minScale: ScaleRangeLayer["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#persistenceEnabled Read more...} */ declare persistenceEnabled: OperationalLayer["persistenceEnabled"]; /** * Refresh interval of the layer in minutes. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#refreshInterval Read more...} */ declare refreshInterval: RefreshableLayer["refreshInterval"]; /** * The service mode for the WMTS layer. * * @default "RESTful" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#serviceMode Read more...} */ serviceMode: "RESTful" | "KVP"; readonly type: "wmts"; /** * The URL of the WMTS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#url Read more...} */ url: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#version Read more...} */ version: string; /** * The WMTSLayer is used to create layers based on OGC Web Map Tile Services (WMTS). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html Read more...} */ constructor(properties?: WMTSLayerProperties); /** * Currently active sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#activeLayer Read more...} */ get activeLayer(): WMTSSublayer; set activeLayer(value: WMTSSublayerProperties); /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html WMTSSublayer} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); /** * Requests a tile from the WMTS service. * * @param level The tile level. * @param row The tile row. * @param col The tile column. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#fetchTile Read more...} */ fetchTile(level: number, row: number, col: number, options?: WMTSLayerFetchTileOptions): Promise; /** * Returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html WMTSSublayer} based on the given sublayer id. * * @param id The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html#id id} of the WMTS sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#findSublayerById Read more...} */ findSublayerById(id: string): WMTSSublayer | nullish; /** * Fetches all the data for the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#refresh Read more...} */ refresh(): void; static fromJSON(json: any): WMTSLayer; } interface WMTSLayerProperties extends LayerProperties, OperationalLayerProperties, PortalLayerProperties, ScaleRangeLayerProperties, RefreshableLayerProperties, BlendLayerProperties { /** * Currently active sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#activeLayer Read more...} */ activeLayer?: WMTSSublayerProperties; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#blendMode Read more...} */ blendMode?: BlendLayerProperties["blendMode"]; /** * Copyright information for the WMTS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#copyright Read more...} */ copyright?: string; /** * Use this to append different custom parameters to the WMTS tile requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#customLayerParameters Read more...} */ customLayerParameters?: any | nullish; /** * Use this to append custom parameters to all WMTS requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#customParameters Read more...} */ customParameters?: any | nullish; /** * Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to * how image filters work. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#effect Read more...} */ effect?: Effect | nullish; /** * The maximum scale (most zoomed in) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#maxScale Read more...} */ maxScale?: ScaleRangeLayerProperties["maxScale"]; /** * The minimum scale (most zoomed out) at which the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#minScale Read more...} */ minScale?: ScaleRangeLayerProperties["minScale"]; /** * Enable persistence of the layer in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#persistenceEnabled Read more...} */ persistenceEnabled?: OperationalLayerProperties["persistenceEnabled"]; /** * The portal item from which the layer is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#refreshInterval Read more...} */ refreshInterval?: RefreshableLayerProperties["refreshInterval"]; /** * The service mode for the WMTS layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#serviceMode Read more...} */ serviceMode?: "RESTful" | "KVP"; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-WMTSSublayer.html WMTSSublayer} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * The URL of the WMTS service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#url Read more...} */ url?: string; /** * Version of the [WMTS specification](http://www.opengeospatial.org/standards/wmts) to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WMTSLayer.html#version Read more...} */ version?: string; } export interface WMTSLayerFetchTileOptions { signal?: AbortSignal | nullish; } export interface ChronologicalLayoutSettings extends Accessor, JSONSupport { } export class ChronologicalLayoutSettings { /** * An integer between 1 and 10 setting the width of the line, in points, representing the duration of events with non-zero durations. * * @default 5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#durationLineWidth Read more...} */ durationLineWidth: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; /** * Determines the placement of an entity along a non-zero duration event interval. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#entityPositionAtDurationRatio Read more...} */ entityPositionAtDurationRatio: number; /** * Controls the display of start and end event ticks on the timeline. * * @default "start-and-end" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#eventsTicksVisualization Read more...} */ eventsTicksVisualization: "none" | "start-and-end" | "start-only"; /** * The multiplier to be used for relationship line separation, where a higher multiplier leads to greater separation between lines. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#lineSeparationMultiplier Read more...} */ lineSeparationMultiplier: number; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps `separateTimelineOverlaps`} is true, indicates whether the first bend on a relationship line related * to an event is raised up above the event location, to reduce overlapping. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#moveFirstBends Read more...} */ moveFirstBends: boolean; /** * Ratio from 0 to 1 controlling the position at which the second bend of a relationship occurs, for event and non-event relationships between event and non-event entities. * * @default 0.3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#secondBendRatio Read more...} */ secondBendRatio: number; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps `separateTimeOverlaps`} is true, adjusts the angle between the extremities of the original and separated lines. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separatedLineShapeRatio Read more...} */ separatedLineShapeRatio: number; /** * Indicates whether events that overlap on a timeline are separated. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps Read more...} */ separateTimelineOverlaps: boolean; /** * Indicates whether events that overlap in time are separated. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps Read more...} */ separateTimeOverlaps: boolean; /** * Determines whether or not lines representing the duration of events on entities with non-zero durations are shown. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#showDurationLineForNonZeroDurationEntityEvents Read more...} */ showDurationLineForNonZeroDurationEntityEvents: boolean; /** * Determines whether to display interval bounds (tick lines at the start and end) of relationship lines for events with non-zero durations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#showNonZeroDurationIntervalBounds Read more...} */ showNonZeroDurationIntervalBounds: boolean; /** * Determines whether or not to space separated lines evenly, when either {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps `separateTimeOverlaps`} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps `separateTimelineOverlaps`} is true. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#spaceSeparatedLinesEvenly Read more...} */ spaceSeparatedLinesEvenly: boolean; /** * The UTC offset in minutes to use for the time banner. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#timeBannerUTCOffsetInMinutes Read more...} */ timeBannerUTCOffsetInMinutes: number; /** * Controls the time axis orientation and the direction along which time increases in the layout, e.g. * * @default "right" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#timeDirection Read more...} */ timeDirection: "bottom" | "left" | "right" | "top"; /** * Determines whether or not to use Bezier curves for separated lines. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#useBezierCurves Read more...} */ useBezierCurves: boolean; /** * Chronological layouts arrange entities and relationships using time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html Read more...} */ constructor(properties?: ChronologicalLayoutSettingsProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ChronologicalLayoutSettings; } interface ChronologicalLayoutSettingsProperties { /** * An integer between 1 and 10 setting the width of the line, in points, representing the duration of events with non-zero durations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#durationLineWidth Read more...} */ durationLineWidth?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10; /** * Determines the placement of an entity along a non-zero duration event interval. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#entityPositionAtDurationRatio Read more...} */ entityPositionAtDurationRatio?: number; /** * Controls the display of start and end event ticks on the timeline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#eventsTicksVisualization Read more...} */ eventsTicksVisualization?: "none" | "start-and-end" | "start-only"; /** * The multiplier to be used for relationship line separation, where a higher multiplier leads to greater separation between lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#lineSeparationMultiplier Read more...} */ lineSeparationMultiplier?: number; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps `separateTimelineOverlaps`} is true, indicates whether the first bend on a relationship line related * to an event is raised up above the event location, to reduce overlapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#moveFirstBends Read more...} */ moveFirstBends?: boolean; /** * Ratio from 0 to 1 controlling the position at which the second bend of a relationship occurs, for event and non-event relationships between event and non-event entities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#secondBendRatio Read more...} */ secondBendRatio?: number; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps `separateTimeOverlaps`} is true, adjusts the angle between the extremities of the original and separated lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separatedLineShapeRatio Read more...} */ separatedLineShapeRatio?: number; /** * Indicates whether events that overlap on a timeline are separated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps Read more...} */ separateTimelineOverlaps?: boolean; /** * Indicates whether events that overlap in time are separated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps Read more...} */ separateTimeOverlaps?: boolean; /** * Determines whether or not lines representing the duration of events on entities with non-zero durations are shown. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#showDurationLineForNonZeroDurationEntityEvents Read more...} */ showDurationLineForNonZeroDurationEntityEvents?: boolean; /** * Determines whether to display interval bounds (tick lines at the start and end) of relationship lines for events with non-zero durations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#showNonZeroDurationIntervalBounds Read more...} */ showNonZeroDurationIntervalBounds?: boolean; /** * Determines whether or not to space separated lines evenly, when either {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimeOverlaps `separateTimeOverlaps`} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#separateTimelineOverlaps `separateTimelineOverlaps`} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#spaceSeparatedLinesEvenly Read more...} */ spaceSeparatedLinesEvenly?: boolean; /** * The UTC offset in minutes to use for the time banner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#timeBannerUTCOffsetInMinutes Read more...} */ timeBannerUTCOffsetInMinutes?: number; /** * Controls the time axis orientation and the direction along which time increases in the layout, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#timeDirection Read more...} */ timeDirection?: "bottom" | "left" | "right" | "top"; /** * Determines whether or not to use Bezier curves for separated lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-ChronologicalLayoutSettings.html#useBezierCurves Read more...} */ useBezierCurves?: boolean; } export interface LayoutSettings extends Accessor, JSONSupport { } export class LayoutSettings { /** * Additional settings for chronological and organic link chart {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html#layoutType layouts}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html Read more...} */ constructor(properties?: LayoutSettingsProperties); /** * Settings for chronological layout calculations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#chronologicalLayoutSettings Read more...} */ get chronologicalLayoutSettings(): ChronologicalLayoutSettings | nullish; set chronologicalLayoutSettings(value: ChronologicalLayoutSettingsProperties | nullish); /** * Settings for organic layout calculations that allow you to customize how the entities are placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#organicLayoutSettings Read more...} */ get organicLayoutSettings(): OrganicLayoutSettings | nullish; set organicLayoutSettings(value: OrganicLayoutSettingsProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LayoutSettings; } interface LayoutSettingsProperties { /** * Settings for chronological layout calculations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#chronologicalLayoutSettings Read more...} */ chronologicalLayoutSettings?: ChronologicalLayoutSettingsProperties | nullish; /** * Settings for organic layout calculations that allow you to customize how the entities are placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LayoutSettings.html#organicLayoutSettings Read more...} */ organicLayoutSettings?: OrganicLayoutSettingsProperties | nullish; } export class LinkChartProperties extends Accessor { /** * Additional settings for chronological and organic link chart layouts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html#layoutSettings Read more...} */ readonly layoutSettings: LayoutSettings | nullish; /** * The link chart layout algorithm used to position entities and relationships on the link chart. * * @default "organic-standard" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html#layoutType Read more...} */ readonly layoutType: | "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-node-centric" | "tree-right-to-left" | "hierarchical-top-to-bottom" | "organic-fusiform" | "organic-leaf-circle" | "tree-top-to-bottom" | "radial-root-centric" | "tree-bottom-to-top" | "tree-left-to-right"; /** * Object that defines instructions on the visualization of nonspatial link chart data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html#nonspatialDataDisplay Read more...} */ readonly nonspatialDataDisplay: NonspatialDataDisplay | nullish; /** * Url pointing to a resource containing featureSet as PBF reference containing a serialized representation of the internal entity table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html#relationshipsUrl Read more...} */ readonly relationshipsUrl: string | nullish; /** * Properties that contain source information, layout configurations and other settings for a Link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html Read more...} */ constructor(properties?: LinkChartPropertiesProperties); } interface LinkChartPropertiesProperties { } export interface NonspatialDataDisplay extends Accessor, JSONSupport { } export class NonspatialDataDisplay { /** * Mode for how nonspatial information should be displayed. * * @default "visible" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-NonspatialDataDisplay.html#mode Read more...} */ mode: "hidden" | "visible"; /** * Object that defines instructions on the visualization of nonspatial link chart data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-NonspatialDataDisplay.html Read more...} */ constructor(properties?: NonspatialDataDisplayProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-NonspatialDataDisplay.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-NonspatialDataDisplay.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): NonspatialDataDisplay; } interface NonspatialDataDisplayProperties { /** * Mode for how nonspatial information should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-NonspatialDataDisplay.html#mode Read more...} */ mode?: "hidden" | "visible"; } export interface OrganicLayoutSettings extends Accessor, JSONSupport { } export class OrganicLayoutSettings { /** * The value, in degrees, to use for the ideal edge length during layout calculations when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLenghtType idealEdgeLengthType} is `absolute-value`. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#absoluteIdealEdgeLength Read more...} */ absoluteIdealEdgeLength: number; /** * Determines whether the repulsion radius should be calculated automatically (`true`), or computed according to `repulsionRadiusMultiplier` (`false`). * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#autoRepulsionRadius Read more...} */ autoRepulsionRadius: boolean; /** * The maximum amount of time in seconds to spend on the layout calculation. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#computationBudgetTime Read more...} */ computationBudgetTime: number | nullish; /** * Determines which property to use to compute the ideal edge length. * * @default "multiplier" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLengthType Read more...} */ idealEdgeLengthType: "absolute-value" | "multiplier"; /** * Value used to multiply the default edge length to determine the ideal edge length during layout calculations, when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLengthType idealEdgeLengthType} is `multiplier`. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#multiplicativeIdealEdgeLength Read more...} */ multiplicativeIdealEdgeLength: number; /** * Value to be used for the repulsion radius multiplier in organic layout calculations. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#repulsionRadiusMultiplier Read more...} */ repulsionRadiusMultiplier: number | nullish; /** * Settings for organic layout calculations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html Read more...} */ constructor(properties?: OrganicLayoutSettingsProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): OrganicLayoutSettings; } interface OrganicLayoutSettingsProperties { /** * The value, in degrees, to use for the ideal edge length during layout calculations when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLenghtType idealEdgeLengthType} is `absolute-value`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#absoluteIdealEdgeLength Read more...} */ absoluteIdealEdgeLength?: number; /** * Determines whether the repulsion radius should be calculated automatically (`true`), or computed according to `repulsionRadiusMultiplier` (`false`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#autoRepulsionRadius Read more...} */ autoRepulsionRadius?: boolean; /** * The maximum amount of time in seconds to spend on the layout calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#computationBudgetTime Read more...} */ computationBudgetTime?: number | nullish; /** * Determines which property to use to compute the ideal edge length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLengthType Read more...} */ idealEdgeLengthType?: "absolute-value" | "multiplier"; /** * Value used to multiply the default edge length to determine the ideal edge length during layout calculations, when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#idealEdgeLengthType idealEdgeLengthType} is `multiplier`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#multiplicativeIdealEdgeLength Read more...} */ multiplicativeIdealEdgeLength?: number; /** * Value to be used for the repulsion radius multiplier in organic layout calculations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-OrganicLayoutSettings.html#repulsionRadiusMultiplier Read more...} */ repulsionRadiusMultiplier?: number | nullish; } export interface Map extends Accessor, LayersMixin, TablesMixin { } export class Map { /** * A flattened collection of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers} in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#allLayers Read more...} */ readonly allLayers: Collection; /** * A flattened collection of tables anywhere in the map's hierarchy. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#allTables Read more...} */ readonly allTables: Collection; /** * A collection of editable layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#editableLayers Read more...} */ readonly editableLayers: Collection< FeatureLayer | SceneLayer | SubtypeGroupLayer | GeoJSONLayer | OrientedImageryLayer >; /** * The Map class contains properties and methods for storing, managing, and overlaying {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} * common to both 2D and 3D viewing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Read more...} */ constructor(properties?: MapProperties); /** * Specifies a basemap for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap Read more...} */ get basemap(): Basemap | nullish; set basemap(value: BasemapProperties | nullish | string); /** * A container of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html focus areas} present in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#focusAreas Read more...} */ get focusAreas(): FocusAreas; set focusAreas(value: FocusAreasProperties); /** * Specifies the surface properties for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#ground Read more...} */ get ground(): Ground; set ground(value: GroundProperties | string); /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties | Layer[]); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables * saved in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} and/or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables Read more...} */ get tables(): Collection; set tables(value: CollectionProperties | Layer[]); /** * Adds a layer to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. * * @param layer Layer or a promise that resolves to a layer to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#add Read more...} */ add(layer: Layer | Promise, index?: number): void; /** * Adds a layer or an array of layers to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. * * @param layers Layer(s) to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#addMany Read more...} */ addMany(layers: Layer[], index?: number): void; /** * Destroys the map, and any associated resources, including its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#ground ground}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#destroy Read more...} */ destroy(): void; /** * Returns a layer based on the given layer ID. * * @param layerId The ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#findLayerById Read more...} */ findLayerById(layerId: string): Layer | nullish; /** * Returns a table based on the given table ID. * * @param tableId The ID assigned to the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#findTableById Read more...} */ findTableById(tableId: string): Layer | nullish; /** * Removes the specified layer from the layers collection. * * @param layer Layer to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#remove Read more...} */ remove(layer: Layer): Layer | nullish; /** * Removes all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#removeAll Read more...} */ removeAll(): Layer[]; /** * Removes the specified layers. * * @param layers Array of layers to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#removeMany Read more...} */ removeMany(layers: Layer[]): Layer[]; /** * Changes the layer order. * * @param layer The layer to be moved. * @param index The index location for placing the layer. The bottom-most layer has an index of `0`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#reorder Read more...} */ reorder(layer: Layer, index: number): Layer | nullish; } interface MapProperties extends LayersMixinProperties, TablesMixinProperties { /** * Specifies a basemap for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap Read more...} */ basemap?: BasemapProperties | nullish | string; /** * A container of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-effects-FocusAreas.html focus areas} present in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#focusAreas Read more...} */ focusAreas?: FocusAreasProperties; /** * Specifies the surface properties for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#ground Read more...} */ ground?: GroundProperties | string; /** * A collection of operational {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers Read more...} */ layers?: CollectionProperties | Layer[]; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables * saved in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} and/or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables Read more...} */ tables?: CollectionProperties | Layer[]; } export interface Network extends Accessor, JSONSupport, Loadable { } export class Network { /** * The full network definition, accessible only when the network is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#dataElement Read more...} */ dataElement: NetworkDataElementJSON | nullish; /** * The physical dataset name of the network as defined in the backend database. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#datasetName Read more...} */ readonly datasetName: string | nullish; /** * Returns the root feature service url which this network is part of. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#featureServiceUrl Read more...} */ readonly featureServiceUrl: string; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Random unique id (UUID) to identify a network as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#id Read more...} */ id: string; /** * The layer id of the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#layerId Read more...} */ readonly layerId: number; /** * The full url to the network layer id as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#layerUrl Read more...} */ layerUrl: string; /** * Indicates whether the network instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * Returns the url of network server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#networkServiceUrl Read more...} */ readonly networkServiceUrl: string; /** * Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#networkSystemLayers Read more...} */ readonly networkSystemLayers: NetworkSystemLayers | nullish; /** * The portal user owner of the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#owner Read more...} */ readonly owner: string | nullish; /** * Converts url to a url object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#parsedUrl Read more...} */ readonly parsedUrl: NetworkParsedUrl; /** * The schema version of the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#schemaGeneration Read more...} */ readonly schemaGeneration: number | nullish; sourceJSON: any; /** * The name of the network as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#title Read more...} */ title: string; /** * The type of the dataset. * * @default "utility" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#type Read more...} */ readonly type: "utility" | "trace"; /** * Class defining high level properties that describes utility networks and trace networks. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html Read more...} */ constructor(properties?: NetworkProperties); /** * The full extent of the network, defined from the service territory used to create the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#fullExtent Read more...} */ get fullExtent(): Extent | nullish; set fullExtent(value: ExtentProperties | nullish); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The spatial reference of the network, defined at the creation of the network, usually from the service territory class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#cancelLoad Read more...} */ cancelLoad(): void; /** * The network consists of sources (classes) and each source has a unique Id. * * @param id The id of the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#getLayerIdBySourceId Read more...} */ getLayerIdBySourceId(id: number): number | nullish; /** * Groups network elements by their layerId. * * @param elements Array of network elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#getObjectIdsFromElements Read more...} */ getObjectIdsFromElements(elements: NetworkElement[]): LayerInfo[]; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#isResolved Read more...} */ isResolved(): boolean; /** * Triggers the loading of the network instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#load Read more...} */ 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. * * @param query The query parameters that are used to determine which named trace configurations will be returned. * @param options The request options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#queryNamedTraceConfigurations Read more...} */ queryNamedTraceConfigurations(query?: NetworkQueryNamedTraceConfigurationsQuery, options?: RequestOptions | null): Promise; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * @param props The parameters that are used to validate the network topology. * @param options The request options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob Read more...} */ submitTopologyValidationJob(props: ValidateTopologyProps, options?: RequestOptions | null): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#toJSON Read more...} */ toJSON(): any; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology]( https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * @param props The parameters that are used to validate the network topology. * @param options The request options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#validateTopology Read more...} */ validateTopology(props: ValidateTopologyProps, options?: RequestOptions | null): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; /** * Creates a new network instance from an * GeoScene Online or GeoScene Enterprise * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * @param params The parameters for loading the portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#fromPortalItem Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#dataElement Read more...} */ dataElement?: NetworkDataElementJSON | nullish; /** * The full extent of the network, defined from the service territory used to create the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#fullExtent Read more...} */ fullExtent?: ExtentProperties | nullish; /** * The version of the geodatabase of the feature service data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * Random unique id (UUID) to identify a network as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#id Read more...} */ id?: string; /** * The full url to the network layer id as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#layerUrl Read more...} */ layerUrl?: string; sourceJSON?: any; /** * The spatial reference of the network, defined at the creation of the network, usually from the service territory class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The name of the network as defined in the webmap spec. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#title Read more...} */ title?: string; } /** * Contains layerUrl, objectIds, and outFields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#LayerInfo Read more...} */ export interface LayerInfo { layerUrl: string; objectIds: number[]; outFields?: string[]; } /** * Contains the full network definition. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#NetworkDataElementJSON Read more...} */ export type NetworkDataElementJSON = any | nullish; export interface NetworkFromPortalItemParams { portalItem: PortalItem; } export interface NetworkParsedUrl { path: string; query?: HashMap; hash?: string; } export interface NetworkQueryNamedTraceConfigurationsQuery { creators?: string[]; globalIds?: string[]; names?: string[]; tags?: string[]; } /** * ValidateTopologyProps represents the parameters for validating a network topology. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#ValidateTopologyProps Read more...} */ export interface ValidateTopologyProps { gdbVersion?: string; sessionID?: string; validateArea: Extent; validationSet?: ValidationSetItemJSON[]; validationType?: "normal" | "rebuild" | "force-rebuild"; } export class NamedTraceConfiguration { /** * The date/time when the trace configuration has been added to the utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#creationDate Read more...} */ creationDate: Date | nullish; /** * The portal user who created the trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#creator Read more...} */ creator: string | nullish; /** * Short description of what kind of trace this trace configuration performs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#description Read more...} */ description: string | nullish; /** * The `globalId` (UUID) uniquely identifies a trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#globalId Read more...} */ globalId: string; /** * The minimum number of starting points required to perform a trace with this particular trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#minStartingPoints Read more...} */ minStartingPoints: "none" | "one" | "many" | nullish; /** * The result types of the trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#resultTypes Read more...} */ resultTypes: any[]; /** * Labels that help identify and search for a particular trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#tags Read more...} */ tags: string[]; /** * The title or the name of the trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#title Read more...} */ title: string; /** * The full definition of the trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#traceConfiguration Read more...} */ traceConfiguration: TraceConfiguration | UNTraceConfiguration | nullish; /** * The trace type defined in this trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NamedTraceConfiguration.html#traceType Read more...} */ traceType: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | "path" | "circuit" | nullish; constructor(properties?: any); } export class NetworkSystemLayers extends Accessor { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} representing the associations * table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#associationsTable Read more...} */ readonly associationsTable: FeatureLayer | nullish; readonly associationsTableId: number | nullish; readonly associationsTableUrl: string | nullish; /** * The layer ID of the service containing the utility network's [dirty areas](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/dirty-areas-in-a-utility-network.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#dirtyAreasLayerId Read more...} */ readonly dirtyAreasLayerId: number | nullish; /** * The service url containing the utility network's [dirty areas](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/dirty-areas-in-a-utility-network.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#dirtyAreasLayerUrl Read more...} */ readonly dirtyAreasLayerUrl: string | nullish; /** * The layer ID of the service containing the network rules table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#rulesTableId Read more...} */ readonly rulesTableId: number | nullish; /** * The service url containing the network rules table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#rulesTableUrl Read more...} */ readonly rulesTableUrl: string | nullish; /** * The layer ID of the service containing the utility network's [Subnetworks table](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/subnetworks-table.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#subnetworksTableId Read more...} */ readonly subnetworksTableId: number | nullish; /** * The service url containing the utility network's [Subnetworks table](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/subnetworks-table.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#subnetworksTableUrl Read more...} */ readonly subnetworksTableUrl: string | nullish; /** * The NetworkSystemLayers contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html Read more...} */ constructor(properties?: NetworkSystemLayersProperties); /** * Loads the layer identified by the `associationsTableUrl` property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-NetworkSystemLayers.html#loadAssociationsTable Read more...} */ loadAssociationsTable(): Promise; } interface NetworkSystemLayersProperties { } export interface Terminal extends Accessor, JSONSupport { } export class Terminal { /** * A unique numeric identifier for the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#id Read more...} */ id: number; /** * The name of the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#name Read more...} */ name: string; /** * A device feature can be assigned a terminal configuration, which could have one or more terminals. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html Read more...} */ constructor(properties?: TerminalProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Terminal; } interface TerminalProperties { /** * A unique numeric identifier for the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#id Read more...} */ id?: number; /** * The name of the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html#name Read more...} */ name?: string; } export interface TerminalConfiguration extends Accessor, JSONSupport { } export class TerminalConfiguration { /** * The default terminal configuration path defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#defaultConfiguration Read more...} */ defaultConfiguration: string | nullish; /** * A unique numeric identifier of the terminal configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#id Read more...} */ id: number | nullish; /** * The name of the terminal configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#name Read more...} */ name: string | nullish; /** * Terminal configurations can be defined as directional or bidirectional. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#traversabilityModel Read more...} */ traversabilityModel: "directional" | "bidirectional" | nullish; /** * A device feature can be assigned a terminal configuration which could have one or more terminals. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html Read more...} */ constructor(properties?: TerminalConfigurationProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html terminals} defined in this configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#terminals Read more...} */ get terminals(): Terminal[]; set terminals(value: TerminalProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TerminalConfiguration; } interface TerminalConfigurationProperties { /** * The default terminal configuration path defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#defaultConfiguration Read more...} */ defaultConfiguration?: string | nullish; /** * A unique numeric identifier of the terminal configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#id Read more...} */ id?: number | nullish; /** * The name of the terminal configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#name Read more...} */ name?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-Terminal.html terminals} defined in this configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#terminals Read more...} */ terminals?: TerminalProperties[]; /** * Terminal configurations can be defined as directional or bidirectional. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TerminalConfiguration.html#traversabilityModel Read more...} */ traversabilityModel?: "directional" | "bidirectional" | nullish; } export interface TopologyValidationJobInfo extends Accessor, JSONSupport { } export class TopologyValidationJobInfo { /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#status Read more...} */ status: "job-waiting" | "job-executing" | "job-succeeded"; /** * GeoScene Server Rest API endpoint to the resource that receives the validate network topology request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#statusUrl Read more...} */ statusUrl: string; /** * Represents information pertaining to the execution of an asynchronous {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob submitTopologyValidationJob()} request on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html Read more...} */ constructor(properties?: TopologyValidationJobInfoProperties); /** * The last date and time the service was updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#lastUpdatedTime Read more...} */ get lastUpdatedTime(): Date | nullish; set lastUpdatedTime(value: DateProperties | nullish); /** * The date and time in which {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob submitTopologyValidationJob()} is first called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#submissionTime Read more...} */ get submissionTime(): Date | nullish; set submissionTime(value: DateProperties | nullish); /** * Sends a request for the current state of this job. * * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#checkJobStatus Read more...} */ checkJobStatus(requestOptions?: any | null): Promise; /** * Stop monitoring this job for status updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#destroy Read more...} */ destroy(): void; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#toJSON Read more...} */ toJSON(): any; /** * Resolves when an asynchronous job has completed. * * @param options Options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#waitForJobCompletion Read more...} */ waitForJobCompletion(options?: TopologyValidationJobInfoWaitForJobCompletionOptions): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TopologyValidationJobInfo; } interface TopologyValidationJobInfoProperties { /** * The last date and time the service was updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#lastUpdatedTime Read more...} */ lastUpdatedTime?: DateProperties | nullish; /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#status Read more...} */ status?: "job-waiting" | "job-executing" | "job-succeeded"; /** * GeoScene Server Rest API endpoint to the resource that receives the validate network topology request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#statusUrl Read more...} */ statusUrl?: string; /** * The date and time in which {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob submitTopologyValidationJob()} is first called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TopologyValidationJobInfo.html#submissionTime Read more...} */ submissionTime?: DateProperties | nullish; } export interface TopologyValidationJobInfoWaitForJobCompletionOptions { interval?: number; statusCallback?: Function; } export class TraceConfiguration { /** * An array of objects representing network attribute or category conditions that serve as barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#conditionBarriers Read more...} */ conditionBarriers: any[]; /** * An array of objects representing function barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#functionBarriers Read more...} */ functionBarriers: any[]; /** * An array of objects representing function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#functions Read more...} */ functions: any[]; /** * Do not stop the trace if the starting point is a barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#ignoreBarriersAtStartingPoints Read more...} */ ignoreBarriersAtStartingPoints: boolean | nullish; /** * Specifies whether the traversability barrier features will be included in the trace results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#includeBarriers Read more...} */ includeBarriers: boolean | nullish; /** * Specifies the type of features returned based on a network attribute or check for a category string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#outputConditions Read more...} */ outputConditions: any[]; /** * Specifies the network attribute name used for determining the shortest path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#shortestPathNetworkAttributeName Read more...} */ shortestPathNetworkAttributeName: string | nullish; /** * Determines whether traversability is applied to both junctions and edges, junctions only, or edges only. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#traversabilityScope Read more...} */ traversabilityScope: "junctions" | "edges" | "junctionsAndEdges" | nullish; /** * Specifies whether an error will be returned if dirty areas are encountered in any of the traversed features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceConfiguration.html#validateConsistency Read more...} */ validateConsistency: boolean | nullish; constructor(properties?: any); } export interface TraceJobInfo extends Accessor, JSONSupport { } export class TraceJobInfo { /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#status Read more...} */ status: "job-waiting" | "job-executing" | "job-succeeded"; /** * GeoScene Server Rest API endpoint to the resource that receives the validate network topology request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#statusUrl Read more...} */ statusUrl: string; /** * Represents information pertaining to the execution of an asynchronous request on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html Read more...} */ constructor(properties?: TraceJobInfoProperties); /** * The last date and time the service was updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#lastUpdatedTime Read more...} */ get lastUpdatedTime(): Date | nullish; set lastUpdatedTime(value: DateProperties | nullish); /** * The date and time in which {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob submitTopologyValidationJob()} is first called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#submissionTime Read more...} */ get submissionTime(): Date | nullish; set submissionTime(value: DateProperties | nullish); /** * Sends a request for the current state of this job. * * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#checkJobStatus Read more...} */ checkJobStatus(requestOptions?: any | null): Promise; /** * Stop monitoring this job for status updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#destroy Read more...} */ destroy(): void; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#toJSON Read more...} */ toJSON(): any; /** * Resolves when an asynchronous job has completed. * * @param options Options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#waitForJobCompletion Read more...} */ waitForJobCompletion(options?: TraceJobInfoWaitForJobCompletionOptions): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TraceJobInfo; } interface TraceJobInfoProperties { /** * The last date and time the service was updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#lastUpdatedTime Read more...} */ lastUpdatedTime?: DateProperties | nullish; /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#status Read more...} */ status?: "job-waiting" | "job-executing" | "job-succeeded"; /** * GeoScene Server Rest API endpoint to the resource that receives the validate network topology request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#statusUrl Read more...} */ statusUrl?: string; /** * The date and time in which {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#submitTopologyValidationJob submitTopologyValidationJob()} is first called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-TraceJobInfo.html#submissionTime Read more...} */ submissionTime?: DateProperties | nullish; } export interface TraceJobInfoWaitForJobCompletionOptions { interval?: any; statusCallback?: any; } export class UNTraceConfiguration { /** * Specifies whether to allow IndeterminateFlow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#allowIndeterminateFlow Read more...} */ allowIndeterminateFlow: boolean | nullish; /** * Allows users to input arcade expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#arcadeExpressionBarrier Read more...} */ arcadeExpressionBarrier: string | nullish; /** * Specifies the diagram Template Name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#diagramTemplateName Read more...} */ diagramTemplateName: string | nullish; /** * Specifies the name of the domain network where the trace will be run. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#domainNetworkName Read more...} */ domainNetworkName: string | nullish; /** * An array of objects representing specific categories or network attributes where the trace will stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#filterBarriers Read more...} */ filterBarriers: any[]; /** * Ensures the trace results include any bit that is set in the starting points for the network attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#filterBitsetNetworkAttributeName Read more...} */ filterBitsetNetworkAttributeName: string | nullish; /** * An array of objects representing filter function barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#filterFunctionBarriers Read more...} */ filterFunctionBarriers: any[]; /** * Specifies where the filter will be applied. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#filterScope Read more...} */ filterScope: "junctions" | "edges" | "junctionsAndEdges" | nullish; /** * Specifies if the container features will be included in the trace results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#includeContainers Read more...} */ includeContainers: boolean | nullish; /** * Specifies if the content in containers will be included in the results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#includeContent Read more...} */ includeContent: boolean | nullish; /** * Specifies whether to include isolated features for an isolation trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#includeIsolated Read more...} */ includeIsolated: boolean | nullish; /** * Specifies if structure features and objects will be included in the trace results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#includeStructures Read more...} */ includeStructures: boolean | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#includeUpToFirstSpatialContainer Read more...} */ includeUpToFirstSpatialContainer: boolean | nullish; /** * Specifies the parameters needed for calculating nearest neighbors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#nearestNeighbor Read more...} */ nearestNeighbor: any | nullish; /** * An array of objects representing the output filter categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#outputFilterCategories Read more...} */ outputFilterCategories: any[]; /** * An array of objects used to control what is returned in the results of a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#outputFilters Read more...} */ outputFilters: any[]; /** * A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#propagators Read more...} */ propagators: any[]; /** * Specifies the name of the [subnetwork](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/subnetworks.htm) where the trace will be run. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#subnetworkName Read more...} */ subnetworkName: string | nullish; /** * Specifies the name of the tier where an upstream or downstream trace ends. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#targetTierName Read more...} */ targetTierName: string | nullish; /** * Specifies the name of the tier where the trace will be run. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#tierName Read more...} */ tierName: string | nullish; /** * Specifies if its necessary to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-support-UNTraceConfiguration.html#validateLocatability Read more...} */ validateLocatability: boolean | nullish; constructor(properties?: any); } export class UtilityNetwork extends Network { /** * Returns all the [domain networks](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/domain-network.htm) in the utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#domainNetworkNames Read more...} */ readonly domainNetworkNames: string[]; /** * Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#networkSystemLayers Read more...} */ readonly networkSystemLayers: NetworkSystemLayers; /** * The layer id of the service territory class used to define the extent of the utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#serviceTerritoryFeatureLayerId Read more...} */ readonly serviceTerritoryFeatureLayerId: number | nullish; /** * This property returns the list of trace configurations shared on the webmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#sharedNamedTraceConfigurations Read more...} */ sharedNamedTraceConfigurations: NamedTraceConfiguration[]; /** * Returns all the terminal configurations on the utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#terminalConfigurations Read more...} */ readonly terminalConfigurations: TerminalConfiguration[]; /** * The type of the dataset. * * @default "utility" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#type Read more...} */ readonly type: "utility"; /** * This class contains metadata about the utility network dataset * retrieved from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html Read more...} */ constructor(properties?: UtilityNetworkProperties); /** * Returns `true` if the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} is valid. * * @param association Association that needs to be validated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#canAddAssociation Read more...} */ canAddAssociation(association: Association): Promise; /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#ServiceEdits ServiceEdits} which are used to add an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} via the `applyEdits` method on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html FeatureService} class. * * @param association `Association` used to generate the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#ServiceEdits ServiceEdits} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#generateAddAssociations Read more...} */ generateAddAssociations(association: Association[]): ServiceEdits; /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#ServiceEdits ServiceEdits} which are used to delete an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} via the `applyEdits` method on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html FeatureService} class. * * @param association `Association` used to generate the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#ServiceEdits ServiceEdits} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#generateDeleteAssociations Read more...} */ generateDeleteAssociations(association: Association[]): ServiceEdits; /** * All devices features have terminal configurations (default single terminal). * * @param feature The graphic feature to get the terminal configuration from. Must belong to a device layer, and have `ASSETGROUP` and `ASSETTYPE` fields populated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#getTerminalConfiguration Read more...} */ getTerminalConfiguration(feature: Graphic): TerminalConfiguration | nullish; /** * Takes the name of a domain network and returns an array with the names of its tiers. * * @param domainNetworkName The name of the domain network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#getTierNames Read more...} */ getTierNames(domainNetworkName: string): string[]; /** * Returns a boolean indicating if the layer is a utility layer belonging to the network. * * @param layer The layer to check if it is a utility layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#isUtilityLayer Read more...} */ isUtilityLayer(layer: Layer | SubtypeSublayer): boolean; /** * Loads the Utility Network's associations table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#loadAssociationsTable Read more...} */ loadAssociationsTable(): Promise; /** * Returns all associations filtered by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters} in a utility network. * * @param props Describes the parameters required to execute the `queryAssociations` method, which returns a list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} filtered by the parameters set. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#queryAssociations Read more...} */ queryAssociations(props: QueryAssociationsParameters): Promise; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology]( https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * @param parameters The parameters that are used to validate the network topology. * @param options The request options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#submitTopologyValidationJob Read more...} */ submitTopologyValidationJob(parameters: ValidateTopologyProps, options?: RequestOptions): Promise; /** * The submitTraceJob method takes a set of parameters, executes the asynchronous trace on the backend, and returns trace results. * * @param props Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#submitTraceJob Read more...} */ submitTraceJob(props: UtilityNetworkSubmitTraceJobProps): Promise; /** * Given an extent, returns all associations within this extent and their synthesized geometries. * * @param params Describes the parameters required to execute the `synthesizeAssociationGeometries` method which synthesizes and returns the associations geometries in a given extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#synthesizeAssociationGeometries Read more...} */ synthesizeAssociationGeometries(params: SynthesizeAssociationGeometriesParameters): Promise; /** * The trace method takes a set of parameters, executes the trace on the backend, and returns trace results. * * @param props Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#trace Read more...} */ trace(props: UtilityNetworkTraceProps): Promise; /** * Whenever the network is edited or modified, the network and its features become out of date in the [network topology](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/about-network-topology.htm). * * @param parameters The parameters that are used to validate the network topology. * @param options The request options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#validateTopology Read more...} */ validateTopology(parameters: ValidateTopologyProps, options?: RequestOptions): Promise; static fromJSON(json: any): UtilityNetwork; } interface UtilityNetworkProperties extends NetworkProperties { /** * This property returns the list of trace configurations shared on the webmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#sharedNamedTraceConfigurations Read more...} */ sharedNamedTraceConfigurations?: NamedTraceConfiguration[]; } /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#generateAddAssociations generateAddAssociations} method and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#generateDeleteAssociations generateDeleteAssociations}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#ServiceEdits Read more...} */ export interface ServiceEdits { id: number; identifierFields: ServiceEditsIdentifierFields; addFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | FeatureIdentifier[]; } export interface UtilityNetworkSubmitTraceJobProps { namedTraceConfigurationGlobalId?: string; traceLocations?: TraceLocation[]; outSpatialReference?: SpatialReference; traceConfiguration?: UNTraceConfiguration; resultTypes?: ResultTypeJSON[]; traceType?: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | nullish; } export interface UtilityNetworkTraceProps { namedTraceConfigurationGlobalId?: string; traceLocations?: TraceLocation[]; outSpatialReference?: SpatialReference; traceConfiguration?: UNTraceConfiguration; resultTypes?: ResultTypeJSON[]; traceType?: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | nullish; } export interface ServiceEditsIdentifierFields { globalIdField: string | nullish; objectIdField: string; } /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html PointCloudRenderer} classes when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes} to import union types, or individual modules to import classes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html Read more...} */ namespace pointCloudRenderers { /** * Renderer types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~PointCloudRendererUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudRenderer Read more...} */ export type PointCloudRenderer = | __geoscene.PointCloudClassBreaksRenderer | __geoscene.PointCloudRGBRenderer | __geoscene.PointCloudStretchRenderer | __geoscene.PointCloudUniqueValueRenderer; /** * PointCloudClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudClassBreaksRenderer Read more...} */ export type PointCloudClassBreaksRenderer = __geoscene.PointCloudClassBreaksRenderer; export const PointCloudClassBreaksRenderer: typeof __geoscene.PointCloudClassBreaksRenderer; /** * PointCloudRGBRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudRGBRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudRGBRenderer Read more...} */ export type PointCloudRGBRenderer = __geoscene.PointCloudRGBRenderer; export const PointCloudRGBRenderer: typeof __geoscene.PointCloudRGBRenderer; /** * PointCloudStretchRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudStretchRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudStretchRenderer Read more...} */ export type PointCloudStretchRenderer = __geoscene.PointCloudStretchRenderer; export const PointCloudStretchRenderer: typeof __geoscene.PointCloudStretchRenderer; /** * PointCloudUniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudUniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudUniqueValueRenderer Read more...} */ export type PointCloudUniqueValueRenderer = __geoscene.PointCloudUniqueValueRenderer; export const PointCloudUniqueValueRenderer: typeof __geoscene.PointCloudUniqueValueRenderer; } /** * PointCloudClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudClassBreaksRenderer Read more...} */ export type pointCloudRenderersPointCloudClassBreaksRenderer = PointCloudClassBreaksRenderer; /** * Renderer types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~PointCloudRendererUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudRenderer Read more...} */ export type pointCloudRenderersPointCloudRenderer = | PointCloudClassBreaksRenderer | PointCloudRGBRenderer | PointCloudStretchRenderer | PointCloudUniqueValueRenderer; /** * PointCloudRGBRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudRGBRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudRGBRenderer Read more...} */ export type pointCloudRenderersPointCloudRGBRenderer = PointCloudRGBRenderer; /** * PointCloudStretchRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudStretchRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudStretchRenderer Read more...} */ export type pointCloudRenderersPointCloudStretchRenderer = PointCloudStretchRenderer; /** * PointCloudUniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PointCloudUniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-pointCloudRenderers.html#PointCloudUniqueValueRenderer Read more...} */ export type pointCloudRenderersPointCloudUniqueValueRenderer = PointCloudUniqueValueRenderer; /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-Content.html Content} classes when developing * with {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html Read more...} */ namespace content { /** * Popup content element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#Content Read more...} */ export type Content = | __geoscene.TextContent | __geoscene.MediaContent | __geoscene.FieldsContent | __geoscene.AttachmentsContent | __geoscene.CustomContent | __geoscene.ExpressionContent | __geoscene.RelationshipContent | __geoscene.UtilityNetworkAssociationsContent; /** * TextContent defines descriptive text as an element within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate's} * content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#TextContent Read more...} */ export type TextContent = __geoscene.TextContent; export const TextContent: typeof __geoscene.TextContent; /** * MediaContent contains an individual or array of chart and/or image media elements * to display within a popup's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#MediaContent Read more...} */ export type MediaContent = __geoscene.MediaContent; export const MediaContent: typeof __geoscene.MediaContent; /** * FieldsContent represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html FieldInfo} associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#FieldsContent Read more...} */ export type FieldsContent = __geoscene.FieldsContent; export const FieldsContent: typeof __geoscene.FieldsContent; /** * AttachmentsContent represents an attachment element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#AttachmentsContent Read more...} */ export type AttachmentsContent = __geoscene.AttachmentsContent; export const AttachmentsContent: typeof __geoscene.AttachmentsContent; /** * CustomContent represents a custom content element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#CustomContent Read more...} */ export type CustomContent = __geoscene.CustomContent; export const CustomContent: typeof __geoscene.CustomContent; /** * ExpressionContent represents an expression element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#ExpressionContent Read more...} */ export type ExpressionContent = __geoscene.ExpressionContent; export const ExpressionContent: typeof __geoscene.ExpressionContent; /** * RelationshipContent represents an relationship element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#RelationshipContent Read more...} */ export type RelationshipContent = __geoscene.RelationshipContent; export const RelationshipContent: typeof __geoscene.RelationshipContent; /** * UtilityNetworkAssociationsContent represents an utility network associations element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#UtilityNetworkAssociationsContent Read more...} */ export type UtilityNetworkAssociationsContent = __geoscene.UtilityNetworkAssociationsContent; export const UtilityNetworkAssociationsContent: typeof __geoscene.UtilityNetworkAssociationsContent; } export interface AttachmentsContent extends Content, JSONSupport, Clonable { } export class AttachmentsContent { /** * Describes the attachment's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#description Read more...} */ description: string | nullish; /** * A string value indicating how to display an attachment. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#displayType Read more...} */ displayType: "auto" | "preview" | "list"; /** * A heading indicating what the attachment's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#title Read more...} */ title: string | nullish; /** * The type of popup element displayed. * * @default "attachments" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#type Read more...} */ readonly type: "attachments"; /** * An `AttachmentsContent` popup element represents an attachment element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html Read more...} */ constructor(properties?: AttachmentsContentProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html AttachmentsOrderByInfo} indicating the display order for the attachments, and whether they should be sorted in ascending or descending order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#orderByFields Read more...} */ get orderByFields(): AttachmentsOrderByInfo[] | nullish; set orderByFields(value: AttachmentsOrderByInfoProperties[] | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttachmentsContent; } interface AttachmentsContentProperties extends ContentProperties { /** * Describes the attachment's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#description Read more...} */ description?: string | nullish; /** * A string value indicating how to display an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#displayType Read more...} */ displayType?: "auto" | "preview" | "list"; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html AttachmentsOrderByInfo} indicating the display order for the attachments, and whether they should be sorted in ascending or descending order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#orderByFields Read more...} */ orderByFields?: AttachmentsOrderByInfoProperties[] | nullish; /** * A heading indicating what the attachment's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html#title Read more...} */ title?: string | nullish; } export interface BarChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class BarChartMediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#altText Read more...} */ declare altText: MediaInfo["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#caption Read more...} */ declare caption: MediaInfo["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#title Read more...} */ declare title: MediaInfo["title"]; /** * Indicates the type of chart. * * @default "bar-chart" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#type Read more...} */ readonly type: string; /** * A `BarChartMediaInfo` is a type of chart media element that represents a bar chart displayed within a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html Read more...} */ constructor(properties?: BarChartMediaInfoProperties); /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#value Read more...} */ get value(): ChartMediaInfoValue | nullish; set value(value: ChartMediaInfoValueProperties | nullish); /** * Creates a deep clone of the BarChartMediaInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#clone Read more...} */ clone(): BarChartMediaInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BarChartMediaInfo; } interface BarChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#altText Read more...} */ altText?: MediaInfoProperties["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#caption Read more...} */ caption?: MediaInfoProperties["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#title Read more...} */ title?: MediaInfoProperties["title"]; /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-BarChartMediaInfo.html#value Read more...} */ value?: ChartMediaInfoValueProperties | nullish; } export interface ColumnChartMediaInfo extends JSONSupport, MediaInfo, ChartMediaInfo { } export class ColumnChartMediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#altText Read more...} */ declare altText: MediaInfo["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#caption Read more...} */ declare caption: MediaInfo["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#title Read more...} */ declare title: MediaInfo["title"]; /** * Indicates the type of chart. * * @default "column-chart" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#type Read more...} */ readonly type: string; /** * A `ColumnChartMediaInfo` is a type of chart media element * that represents a column chart displayed within a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html Read more...} */ constructor(properties?: ColumnChartMediaInfoProperties); /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#value Read more...} */ get value(): ChartMediaInfoValue | nullish; set value(value: ChartMediaInfoValueProperties | nullish); /** * Creates a deep clone of the ColumnChartMediaInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#clone Read more...} */ clone(): ColumnChartMediaInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColumnChartMediaInfo; } interface ColumnChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#altText Read more...} */ altText?: MediaInfoProperties["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#caption Read more...} */ caption?: MediaInfoProperties["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#title Read more...} */ title?: MediaInfoProperties["title"]; /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ColumnChartMediaInfo.html#value Read more...} */ value?: ChartMediaInfoValueProperties | nullish; } export interface Content extends Accessor, JSONSupport { } export class Content { /** * The type of popup element displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-Content.html#type Read more...} */ readonly type: | "text" | "fields" | "media" | "attachments" | "custom" | "expression" | "relationship" | "utility-network-associations" | nullish; /** * Content elements define what should display within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-Content.html Read more...} */ constructor(properties?: ContentProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-Content.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-Content.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#creator Read more...} */ creator: PopupTemplateContentCreator | PopupTemplateContent | Promise | nullish; /** * The called function to cleanup custom content when it is no longer necessary. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#destroyer Read more...} */ destroyer: PopupTemplateContentDestroyer | nullish; /** * An array of field names used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#outFields Read more...} */ outFields: string[] | nullish; /** * The type of popup element displayed. * * @default "custom" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#type Read more...} */ readonly type: "custom"; /** * A `CustomContent` popup element is used to provide a way to customize the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html popup's} content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html Read more...} */ constructor(properties?: CustomContentProperties); /** * Creates a deep clone of the CustomContent class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#clone Read more...} */ clone(): CustomContent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CustomContent; } interface CustomContentProperties extends ContentProperties { /** * The function that is called to create the custom content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#creator Read more...} */ creator?: PopupTemplateContentCreator | PopupTemplateContent | Promise | nullish; /** * The called function to cleanup custom content when it is no longer necessary. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#destroyer Read more...} */ destroyer?: PopupTemplateContentDestroyer | nullish; /** * An array of field names used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#outFields Read more...} */ outFields?: string[] | nullish; } /** * Custom element content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#PopupTemplateContent Read more...} */ export type PopupTemplateContent = string | HTMLElement | Widget | nullish; export type PopupTemplateContentCreator = ( event?: PopupTemplateCreatorEvent, ) => PopupTemplateContent | Promise; export type PopupTemplateContentDestroyer = (event?: PopupTemplateCreatorEvent) => void; /** * The event that contains the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} used to represent the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-CustomContent.html#PopupTemplateCreatorEvent Read more...} */ export interface PopupTemplateCreatorEvent { graphic: Graphic; } export interface ExpressionContent extends Content, JSONSupport { } export class ExpressionContent { /** * The type of popup element displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#type Read more...} */ readonly type: "expression"; /** * An ExpressionContent element allows you to define a popup content element with an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html Read more...} */ constructor(properties?: ExpressionContentProperties); /** * Contains the Arcade expression used to create a popup content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#expressionInfo Read more...} */ get expressionInfo(): ElementExpressionInfo; set expressionInfo(value: ElementExpressionInfoProperties); /** * Creates a deep clone of the ExpressionContent instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#clone Read more...} */ clone(): ExpressionContent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ExpressionContent; } interface ExpressionContentProperties extends ContentProperties { /** * Contains the Arcade expression used to create a popup content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html#expressionInfo Read more...} */ expressionInfo?: ElementExpressionInfoProperties; } export interface FieldsContent extends Content, JSONSupport { } export class FieldsContent { /** * Describes the field's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#description Read more...} */ description: string | nullish; /** * Heading indicating what the field's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#title Read more...} */ title: string | nullish; /** * The type of popup element displayed. * * @default "fields" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#type Read more...} */ readonly type: "fields"; /** * A `FieldsContent` popup element represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html FieldInfo} associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html Read more...} */ constructor(properties?: FieldsContentProperties); /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html fieldInfos}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#fieldInfos Read more...} */ get fieldInfos(): FieldInfo[] | nullish; set fieldInfos(value: FieldInfoProperties[] | nullish); /** * Creates a deep clone of the FieldsContent class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#clone Read more...} */ clone(): FieldsContent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FieldsContent; } interface FieldsContentProperties extends ContentProperties { /** * Describes the field's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#description Read more...} */ description?: string | nullish; /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html fieldInfos}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#fieldInfos Read more...} */ fieldInfos?: FieldInfoProperties[] | nullish; /** * Heading indicating what the field's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html#title Read more...} */ title?: string | nullish; } export interface ImageMediaInfo extends Accessor, JSONSupport, MediaInfo { } export class ImageMediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#altText Read more...} */ declare altText: MediaInfo["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#caption Read more...} */ declare caption: MediaInfo["caption"]; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#refreshInterval Read more...} */ refreshInterval: number; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#title Read more...} */ declare title: MediaInfo["title"]; /** * The type of popup element. * * @default "image" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#type Read more...} */ readonly type: string; /** * An `ImageMediaInfo` is a type of media element that represents images to display within a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html Read more...} */ constructor(properties?: ImageMediaInfoProperties); /** * Defines the value format of the image media element and how the images should be retrieved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#value Read more...} */ get value(): ImageMediaInfoValue | nullish; set value(value: ImageMediaInfoValueProperties | nullish); /** * Creates a deep clone of the ImageMediaInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#clone Read more...} */ clone(): ImageMediaInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageMediaInfo; } interface ImageMediaInfoProperties extends MediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#altText Read more...} */ altText?: MediaInfoProperties["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#caption Read more...} */ caption?: MediaInfoProperties["caption"]; /** * Refresh interval of the layer in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#refreshInterval Read more...} */ refreshInterval?: number; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#title Read more...} */ title?: MediaInfoProperties["title"]; /** * Defines the value format of the image media element and how the images should be retrieved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ImageMediaInfo.html#value Read more...} */ value?: ImageMediaInfoValueProperties | nullish; } export interface LineChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class LineChartMediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#altText Read more...} */ declare altText: MediaInfo["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#caption Read more...} */ declare caption: MediaInfo["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#title Read more...} */ declare title: MediaInfo["title"]; /** * Indicates the type of chart. * * @default "line-chart" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#type Read more...} */ readonly type: string; /** * A `LineChartMediaInfo` is a type of chart media element * that represents a line chart displayed within a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html Read more...} */ constructor(properties?: LineChartMediaInfoProperties); /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#value Read more...} */ get value(): ChartMediaInfoValue | nullish; set value(value: ChartMediaInfoValueProperties | nullish); /** * Creates a deep clone of the LineChartMediaInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#clone Read more...} */ clone(): LineChartMediaInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LineChartMediaInfo; } interface LineChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#altText Read more...} */ altText?: MediaInfoProperties["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#caption Read more...} */ caption?: MediaInfoProperties["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#title Read more...} */ title?: MediaInfoProperties["title"]; /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-LineChartMediaInfo.html#value Read more...} */ value?: ChartMediaInfoValueProperties | nullish; } export interface MediaContent extends Content, JSONSupport { } export class MediaContent { /** * Index of the current active media within the popup's media content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#activeMediaInfoIndex Read more...} */ activeMediaInfoIndex: number | nullish; /** * Describes the media's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#description Read more...} */ description: string | nullish; /** * Heading indicating what the media's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#title Read more...} */ title: string | nullish; /** * The type of popup element displayed. * * @default "media" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html Read more...} */ constructor(properties?: MediaContentProperties); /** * Contains the media elements representing images or charts to display * within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#mediaInfos Read more...} */ get mediaInfos(): | BarChartMediaInfo | ColumnChartMediaInfo | ImageMediaInfo | LineChartMediaInfo | PieChartMediaInfo | any[] | nullish; set mediaInfos(value: | BarChartMediaInfoProperties | ColumnChartMediaInfoProperties | ImageMediaInfoProperties | LineChartMediaInfoProperties | PieChartMediaInfoProperties | any[] | nullish); /** * Creates a deep clone of the MediaContent class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#clone Read more...} */ clone(): MediaContent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MediaContent; } interface MediaContentProperties extends ContentProperties { /** * Index of the current active media within the popup's media content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#activeMediaInfoIndex Read more...} */ activeMediaInfoIndex?: number | nullish; /** * Describes the media's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#description Read more...} */ description?: string | nullish; /** * Contains the media elements representing images or charts to display * within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#mediaInfos Read more...} */ mediaInfos?: | BarChartMediaInfoProperties | ColumnChartMediaInfoProperties | ImageMediaInfoProperties | LineChartMediaInfoProperties | PieChartMediaInfoProperties | any[] | nullish; /** * Heading indicating what the media's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-MediaContent.html#title Read more...} */ title?: string | nullish; } export class ChartMediaInfo { get value(): ChartMediaInfoValue | nullish; set value(value: ChartMediaInfoValueProperties | nullish); } interface ChartMediaInfoProperties { value?: ChartMediaInfoValueProperties | nullish; } export class MediaInfo { altText: string | nullish; caption: string; title: string; } interface MediaInfoProperties { altText?: string | nullish; caption?: string; title?: string; } export interface PieChartMediaInfo extends Accessor, JSONSupport, MediaInfo, ChartMediaInfo { } export class PieChartMediaInfo { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#altText Read more...} */ declare altText: MediaInfo["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#caption Read more...} */ declare caption: MediaInfo["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#title Read more...} */ declare title: MediaInfo["title"]; /** * Indicates the type of chart. * * @default "pie-chart" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#type Read more...} */ readonly type: string; /** * A `PieChartMediaInfo` is a type of chart media element that represents a pie chart displayed within a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html Read more...} */ constructor(properties?: PieChartMediaInfoProperties); /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#value Read more...} */ get value(): ChartMediaInfoValue | nullish; set value(value: ChartMediaInfoValueProperties | nullish); /** * Creates a deep clone of the PieChartMediaInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#clone Read more...} */ clone(): PieChartMediaInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PieChartMediaInfo; } interface PieChartMediaInfoProperties extends MediaInfoProperties, ChartMediaInfoProperties { /** * Provides an alternate text for an image if the image cannot be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#altText Read more...} */ altText?: MediaInfoProperties["altText"]; /** * Defines a caption for the media. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#caption Read more...} */ caption?: MediaInfoProperties["caption"]; /** * The title of the media element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#title Read more...} */ title?: MediaInfoProperties["title"]; /** * Defines the chart value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-PieChartMediaInfo.html#value Read more...} */ value?: ChartMediaInfoValueProperties | nullish; } export interface RelationshipContent extends Content, JSONSupport, Clonable { } export class RelationshipContent { /** * Describes the relationship's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#description Read more...} */ description: string | nullish; /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#displayCount Read more...} */ displayCount: number; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#displayType Read more...} */ displayType: "list"; /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#relationshipId Read more...} */ relationshipId: number; /** * A heading indicating what the relationship's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#title Read more...} */ title: string | nullish; /** * The type of popup element displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#type Read more...} */ readonly type: "relationship"; /** * A `RelationshipContent` popup element represents a relationship element associated with a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html Read more...} */ constructor(properties?: RelationshipContentProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} indicating the display order for the related records, and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#orderByFields Read more...} */ get orderByFields(): RelatedRecordsInfoFieldOrder[] | nullish; set orderByFields(value: RelatedRecordsInfoFieldOrderProperties[] | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RelationshipContent; } interface RelationshipContentProperties extends ContentProperties { /** * Describes the relationship's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#description Read more...} */ description?: string | nullish; /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#displayCount Read more...} */ displayCount?: number; /** * A string value indicating how to display related records within the relationship content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#displayType Read more...} */ displayType?: "list"; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} indicating the display order for the related records, and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#orderByFields Read more...} */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[] | nullish; /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#relationshipId Read more...} */ relationshipId?: number; /** * A heading indicating what the relationship's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-RelationshipContent.html#title Read more...} */ title?: string | nullish; } export interface ChartMediaInfoValue extends Accessor, JSONSupport { } export class ChartMediaInfoValue { /** * An optional array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html colors} where each color corresponds respectively to a field in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#fields fields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#colors Read more...} */ colors: Color[] | nullish; /** * An array of strings, with each string containing the name of a field to display in the chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#fields Read more...} */ fields: string[]; /** * A string containing the name of a field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#normalizeField Read more...} */ normalizeField: string | nullish; /** * String value indicating the tooltip for a chart specified from another field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#tooltipField Read more...} */ tooltipField: string | nullish; /** * The `ChartMediaInfoValue` class contains information for popups regarding how charts should be constructed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html Read more...} */ constructor(properties?: ChartMediaInfoValueProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html ChartMediaInfoValueSeries} objects which provide * information of x/y data that is plotted in a chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#series Read more...} */ get series(): ChartMediaInfoValueSeries[]; set series(value: ChartMediaInfoValueSeriesProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ChartMediaInfoValue; } interface ChartMediaInfoValueProperties { /** * An optional array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html colors} where each color corresponds respectively to a field in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#fields fields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#colors Read more...} */ colors?: Color[] | nullish; /** * An array of strings, with each string containing the name of a field to display in the chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#fields Read more...} */ fields?: string[]; /** * A string containing the name of a field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#normalizeField Read more...} */ normalizeField?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html ChartMediaInfoValueSeries} objects which provide * information of x/y data that is plotted in a chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#series Read more...} */ series?: ChartMediaInfoValueSeriesProperties[]; /** * String value indicating the tooltip for a chart specified from another field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValue.html#tooltipField Read more...} */ tooltipField?: string | nullish; } export class ChartMediaInfoValueSeries extends Accessor { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} representing the field for a series. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html#color Read more...} */ readonly color: Color | nullish; /** * String value indicating the field's name for a series. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html#fieldName Read more...} */ readonly fieldName: string; /** * String value indicating the tooltip for a series. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html#tooltip Read more...} */ readonly tooltip: string | nullish; /** * Numerical value for the chart series. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html#value Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html Read more...} */ constructor(properties?: ChartMediaInfoValueSeriesProperties); /** * Creates a deep clone of the ChartMediaInfoValueSeries class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ChartMediaInfoValueSeries.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#linkURL Read more...} */ linkURL: string | nullish; /** * A string containing the URL to the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#sourceURL Read more...} */ sourceURL: string | nullish; /** * The `ImageMediaInfoValue` class contains information for popups regarding how images should be retrieved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html Read more...} */ constructor(properties?: ImageMediaInfoValueProperties); /** * Creates a deep clone of the ImageMediaInfoValue class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#clone Read more...} */ clone(): ImageMediaInfoValue; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageMediaInfoValue; } interface ImageMediaInfoValueProperties { /** * A string containing a URL to be launched in a browser when a user clicks the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#linkURL Read more...} */ linkURL?: string | nullish; /** * A string containing the URL to the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-support-ImageMediaInfoValue.html#sourceURL Read more...} */ sourceURL?: string | nullish; } export interface TextContent extends Content, JSONSupport { } export class TextContent { /** * The formatted string content to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#text Read more...} */ text: string | nullish; /** * The type of popup element displayed. * * @default "text" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#type Read more...} */ readonly type: "text"; /** * A `TextContent` popup element is used to define descriptive text as an element within a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate's} * content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html Read more...} */ constructor(properties?: TextContentProperties); /** * Creates a deep clone of the TextContent class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#clone Read more...} */ clone(): TextContent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TextContent; } interface TextContentProperties extends ContentProperties { /** * The formatted string content to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-TextContent.html#text Read more...} */ text?: string | nullish; } export interface UtilityNetworkAssociationsContent extends Content, JSONSupport, Clonable { } export class UtilityNetworkAssociationsContent { /** * Describes the relationship's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#description Read more...} */ description: string | nullish; /** * A numeric value indicating the maximum number of features to display in the list of associated features per layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#displayCount Read more...} */ displayCount: number; /** * A heading indicating what the relationship's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#title Read more...} */ title: string | nullish; /** * The type of popup element displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#type Read more...} */ readonly type: "utility-network-associations"; /** * The `UtilityNetworkAssociationsContent` class is a specialized popup element used to display associated features in a utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html Read more...} */ constructor(properties?: UtilityNetworkAssociationsContentProperties); /** * The popup association types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#associationTypes Read more...} */ get associationTypes(): UtilityNetworkAssociationType[]; set associationTypes(value: UtilityNetworkAssociationTypeProperties[]); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UtilityNetworkAssociationsContent; } interface UtilityNetworkAssociationsContentProperties extends ContentProperties { /** * The popup association types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#associationTypes Read more...} */ associationTypes?: UtilityNetworkAssociationTypeProperties[]; /** * Describes the relationship's content in detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#description Read more...} */ description?: string | nullish; /** * A numeric value indicating the maximum number of features to display in the list of associated features per layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#displayCount Read more...} */ displayCount?: number; /** * A heading indicating what the relationship's content represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-UtilityNetworkAssociationsContent.html#title Read more...} */ title?: string | nullish; } /** * AttachmentsContent represents an attachment element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#AttachmentsContent Read more...} */ export type contentAttachmentsContent = AttachmentsContent; /** * Popup content element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#Content Read more...} */ export type contentContent = | TextContent | MediaContent | FieldsContent | AttachmentsContent | CustomContent | ExpressionContent | RelationshipContent | UtilityNetworkAssociationsContent; /** * CustomContent represents a custom content element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#CustomContent Read more...} */ export type contentCustomContent = CustomContent; /** * ExpressionContent represents an expression element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#ExpressionContent Read more...} */ export type contentExpressionContent = ExpressionContent; /** * FieldsContent represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html FieldInfo} associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#FieldsContent Read more...} */ export type contentFieldsContent = FieldsContent; /** * MediaContent contains an individual or array of chart and/or image media elements * to display within a popup's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#MediaContent Read more...} */ export type contentMediaContent = MediaContent; /** * RelationshipContent represents an relationship element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#RelationshipContent Read more...} */ export type contentRelationshipContent = RelationshipContent; /** * TextContent defines descriptive text as an element within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate's} * content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#TextContent Read more...} */ export type contentTextContent = TextContent; /** * UtilityNetworkAssociationsContent represents an utility network associations element associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content.html#UtilityNetworkAssociationsContent Read more...} */ export type contentUtilityNetworkAssociationsContent = UtilityNetworkAssociationsContent; export interface ElementExpressionInfo extends Accessor, JSONSupport { } export class ElementExpressionInfo { /** * The {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression evaluating to * a dictionary. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#expression Read more...} */ expression: string; /** * The return type of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#returnType Read more...} */ readonly returnType: "dictionary"; /** * The title used to describe the popup element returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#title Read more...} */ title: string | nullish; /** * Defines an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression used to create an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} * element in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html Read more...} */ constructor(properties?: ElementExpressionInfoProperties); /** * Creates a deep clone of the ElementExpressionInfo instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#clone Read more...} */ clone(): ElementExpressionInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ElementExpressionInfo; } interface ElementExpressionInfoProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression evaluating to * a dictionary. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#expression Read more...} */ expression?: string; /** * The title used to describe the popup element returned by the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ElementExpressionInfo.html#title Read more...} */ title?: string | nullish; } export interface popupExpressionInfo extends Accessor, JSONSupport { } export class popupExpressionInfo { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#popup Arcade Popup Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#expression Read more...} */ expression: string; /** * The name of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#name Read more...} */ name: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#returnType Read more...} */ returnType: "string" | "number"; /** * The title used to describe the value returned by the expression in the * popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#title Read more...} */ title: string | nullish; /** * The `ExpressionInfo` class references {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#popup Arcade Popup Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html Read more...} */ constructor(properties?: popupExpressionInfoProperties); /** * Creates a deep clone of the ExpressionInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#clone Read more...} */ clone(): popupExpressionInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): popupExpressionInfo; } interface popupExpressionInfoProperties { /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#popup Arcade Popup Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#expression Read more...} */ expression?: string; /** * The name of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#name Read more...} */ name?: string; /** * Indicates the return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#returnType Read more...} */ returnType?: "string" | "number"; /** * The title used to describe the value returned by the expression in the * popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html#title Read more...} */ title?: string | nullish; } export interface FieldInfo extends Accessor, JSONSupport { } export class FieldInfo { /** * The field name as defined by the service or the name of * an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#fieldName Read more...} */ fieldName: string | nullish; /** * A Boolean determining whether users can edit this field. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#isEditable Read more...} */ isEditable: boolean; /** * A string containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#label Read more...} */ label: string | nullish; /** * Used in a `one:many` or `many:many` relationship to compute the statistics * on the field to show in the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#statisticType Read more...} */ statisticType: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | nullish; /** * A string determining what type of input box editors see * when editing the field. * * @default "text-box" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#stringFieldOption Read more...} */ stringFieldOption: "rich-text" | "text-area" | "text-box"; /** * A string providing an editing hint for editors of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#tooltip Read more...} */ tooltip: string | nullish; /** * Indicates whether the field is visible in the popup window. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#visible Read more...} */ visible: boolean; /** * The `FieldInfo` class defines how a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} participates, * or in some cases, does not participate, in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html Read more...} */ constructor(properties?: FieldInfoProperties); /** * Class which provides formatting options for numerical or date fields and how they should display within * a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#format Read more...} */ get format(): FieldInfoFormat | nullish; set format(value: FieldInfoFormatProperties | nullish); /** * Creates a deep clone of the FieldInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#clone Read more...} */ clone(): FieldInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FieldInfo; } interface FieldInfoProperties { /** * The field name as defined by the service or the name of * an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#fieldName Read more...} */ fieldName?: string | nullish; /** * Class which provides formatting options for numerical or date fields and how they should display within * a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#format Read more...} */ format?: FieldInfoFormatProperties | nullish; /** * A Boolean determining whether users can edit this field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#isEditable Read more...} */ isEditable?: boolean; /** * A string containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#label Read more...} */ label?: string | nullish; /** * Used in a `one:many` or `many:many` relationship to compute the statistics * on the field to show in the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#statisticType Read more...} */ statisticType?: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | nullish; /** * A string determining what type of input box editors see * when editing the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#stringFieldOption Read more...} */ stringFieldOption?: "rich-text" | "text-area" | "text-box"; /** * A string providing an editing hint for editors of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#tooltip Read more...} */ tooltip?: string | nullish; /** * Indicates whether the field is visible in the popup window. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html#visible Read more...} */ visible?: boolean; } export interface LayerOptions extends Accessor, JSONSupport { } export class LayerOptions { /** * Applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html Imagery Layers}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#returnTopmostRaster Read more...} */ returnTopmostRaster: boolean | nullish; /** * Applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html Imagery Layers}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#showNoDataRecords Read more...} */ showNoDataRecords: boolean | nullish; /** * The `LayerOptions` class defines additional options that can be * defined for a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html Read more...} */ constructor(properties?: LayerOptionsProperties); /** * Creates a deep clone of the LayerOptions class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#clone Read more...} */ clone(): LayerOptions; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LayerOptions; } interface LayerOptionsProperties { /** * Applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html Imagery Layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#returnTopmostRaster Read more...} */ returnTopmostRaster?: boolean | nullish; /** * Applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html Imagery Layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-LayerOptions.html#showNoDataRecords Read more...} */ showNoDataRecords?: boolean | nullish; } export interface RelatedRecordsInfo extends Accessor, JSONSupport { } export class RelatedRecordsInfo { /** * Indicates whether to display related records in the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#showRelatedRecords Read more...} */ showRelatedRecords: boolean | nullish; /** * The `RelatedRecordsInfo` class provides additional sorting options * when working with related records in a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html Read more...} */ constructor(properties?: RelatedRecordsInfoProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} * objects indicating the field display order for the related records * and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#orderByFields Read more...} */ get orderByFields(): RelatedRecordsInfoFieldOrder[] | nullish; set orderByFields(value: RelatedRecordsInfoFieldOrderProperties[] | nullish); /** * Creates a deep clone of the RelatedRecordsInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#clone Read more...} */ clone(): RelatedRecordsInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RelatedRecordsInfo; } interface RelatedRecordsInfoProperties { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} * objects indicating the field display order for the related records * and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#orderByFields Read more...} */ orderByFields?: RelatedRecordsInfoFieldOrderProperties[] | nullish; /** * Indicates whether to display related records in the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-RelatedRecordsInfo.html#showRelatedRecords Read more...} */ showRelatedRecords?: boolean | nullish; } export interface AttachmentsOrderByInfo extends Accessor, Clonable, JSONSupport { } export class AttachmentsOrderByInfo { /** * An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html AttachmentInfo} field value that will drive the sorting of attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#field Read more...} */ field: string | nullish; /** * Set the ascending or descending sort order of the attachments. * * @default "ascending" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#order Read more...} */ order: "ascending" | "descending"; /** * The `AttachmentsOrderByInfo` class indicates the attachment field display order for the attachments configured in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-AttachmentsContent.html AttachmentsContent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html Read more...} */ constructor(properties?: AttachmentsOrderByInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttachmentsOrderByInfo; } interface AttachmentsOrderByInfoProperties { /** * An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html AttachmentInfo} field value that will drive the sorting of attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#field Read more...} */ field?: string | nullish; /** * Set the ascending or descending sort order of the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html#order Read more...} */ order?: "ascending" | "descending"; } export interface FieldInfoFormat extends Accessor, JSONSupport, Clonable { } export class FieldInfoFormat { /** * Used only with `Date` fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#dateFormat Read more...} */ dateFormat: | "short-date" | "short-date-short-time" | "short-date-short-time-24" | "short-date-long-time" | "short-date-long-time-24" | "short-date-le" | "short-date-le-short-time" | "short-date-le-short-time-24" | "short-date-le-long-time" | "short-date-le-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" | nullish; /** * Used only with `Number` fields. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#digitSeparator Read more...} */ digitSeparator: boolean; /** * Used only with `Number` fields to specify the number of supported decimal places * that should appear in popups. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#places Read more...} */ places: number | nullish; /** * The `FieldInfoFormat` class is used with numerical or date fields to provide more detail * about how the value should be displayed in a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html Read more...} */ constructor(properties?: FieldInfoFormatProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FieldInfoFormat; } interface FieldInfoFormatProperties { /** * Used only with `Date` fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#dateFormat Read more...} */ dateFormat?: | "short-date" | "short-date-short-time" | "short-date-short-time-24" | "short-date-long-time" | "short-date-long-time-24" | "short-date-le" | "short-date-le-short-time" | "short-date-le-short-time-24" | "short-date-le-long-time" | "short-date-le-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" | nullish; /** * Used only with `Number` fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#digitSeparator Read more...} */ digitSeparator?: boolean; /** * Used only with `Number` fields to specify the number of supported decimal places * that should appear in popups. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-FieldInfoFormat.html#places Read more...} */ places?: number | nullish; } export interface RelatedRecordsInfoFieldOrder extends Accessor, JSONSupport { } export class RelatedRecordsInfoFieldOrder { /** * The attribute value of the field selected that will drive * the sorting of related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#field Read more...} */ field: string; /** * Set the ascending or descending sort order of the returned related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#order Read more...} */ order: "asc" | "desc"; /** * The `RelatedRecordsInfoFieldOrder` class indicates the field display order for the * related records in a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html Read more...} */ constructor(properties?: RelatedRecordsInfoFieldOrderProperties); /** * Creates a deep clone of the RelatedRecordsInfoFieldOrder class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#clone Read more...} */ clone(): RelatedRecordsInfoFieldOrder; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RelatedRecordsInfoFieldOrder; } interface RelatedRecordsInfoFieldOrderProperties { /** * The attribute value of the field selected that will drive * the sorting of related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#field Read more...} */ field?: string; /** * Set the ascending or descending sort order of the returned related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html#order Read more...} */ order?: "asc" | "desc"; } export interface UtilityNetworkAssociationType extends JSONSupport, Clonable { } export class UtilityNetworkAssociationType { /** * This property is used to filter the associations by asset group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedAssetGroup Read more...} */ associatedAssetGroup: number; /** * This property is used to filter the associations by asset type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedAssetType Read more...} */ associatedAssetType: number; /** * This property is used to filter the associations by network sourceId. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedNetworkSourceId Read more...} */ associatedNetworkSourceId: number; /** * The description for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type type} of association in the list of association {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type types} on the popup or form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#description Read more...} */ description: string; /** * The title for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type type} of association in the list of association {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type types} on the popup or form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#title Read more...} */ title: string; /** * The type of association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type Read more...} */ type: "attachment" | "connectivity" | "container" | "content" | "structure"; /** * The `UtilityNetworkAssociationType` class defines one utility network association type used in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html Read more...} */ constructor(properties?: UtilityNetworkAssociationTypeProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UtilityNetworkAssociationType; } interface UtilityNetworkAssociationTypeProperties { /** * This property is used to filter the associations by asset group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedAssetGroup Read more...} */ associatedAssetGroup?: number; /** * This property is used to filter the associations by asset type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedAssetType Read more...} */ associatedAssetType?: number; /** * This property is used to filter the associations by network sourceId. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#associatedNetworkSourceId Read more...} */ associatedNetworkSourceId?: number; /** * The description for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type type} of association in the list of association {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type types} on the popup or form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#description Read more...} */ description?: string; /** * The title for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type type} of association in the list of association {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type types} on the popup or form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#title Read more...} */ title?: string; /** * The type of association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-UtilityNetworkAssociationType.html#type Read more...} */ type?: "attachment" | "connectivity" | "container" | "content" | "structure"; } export interface PopupTemplate extends Accessor, Clonable, JSONSupport { } export class PopupTemplate { /** * Indicates whether or not editor tracking should display. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#lastEditInfoEnabled Read more...} */ lastEditInfoEnabled: boolean; /** * An array of field names used in the PopupTemplate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#outFields Read more...} */ outFields: string[] | nullish; /** * Indicates whether actions should replace existing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions popup actions}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#overwriteActions Read more...} */ overwriteActions: boolean; /** * Indicates whether to include the feature's geometry for use by the template. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * The template for defining how to format the title used in a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#title Read more...} */ title: string | Function | Promise; /** * A PopupTemplate formats and defines the content of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} for * a specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html Read more...} */ constructor(properties?: PopupTemplateProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#actions Read more...} */ get actions(): Collection | nullish; set actions(value: | CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) > | nullish); /** * The template for defining and formatting a popup's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#content Read more...} */ get content(): Content[] | string | Function | Promise | nullish; set content(value: ContentProperties[] | string | Function | Promise | nullish); /** * An array of objects or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo[]} that reference * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#popup Arcade Popup Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#expressionInfos Read more...} */ get expressionInfos(): popupExpressionInfo[] | nullish; set expressionInfos(value: popupExpressionInfoProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html FieldInfo} that defines how fields in the dataset * or values from {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions participate * in a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#fieldInfos Read more...} */ get fieldInfos(): FieldInfo[] | nullish; set fieldInfos(value: FieldInfoProperties[] | nullish); /** * Additional options that can be defined for the popup layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#layerOptions Read more...} */ get layerOptions(): LayerOptions | nullish; set layerOptions(value: LayerOptionsProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PopupTemplate; } interface PopupTemplateProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#actions Read more...} */ actions?: | CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) > | nullish; /** * The template for defining and formatting a popup's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#content Read more...} */ content?: ContentProperties[] | string | Function | Promise | nullish; /** * An array of objects or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo[]} that reference * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions following * the specification defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#popup Arcade Popup Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#expressionInfos Read more...} */ expressionInfos?: popupExpressionInfoProperties[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html FieldInfo} that defines how fields in the dataset * or values from {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions participate * in a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#fieldInfos Read more...} */ fieldInfos?: FieldInfoProperties[] | nullish; /** * Indicates whether or not editor tracking should display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#lastEditInfoEnabled Read more...} */ lastEditInfoEnabled?: boolean; /** * Additional options that can be defined for the popup layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#layerOptions Read more...} */ layerOptions?: LayerOptionsProperties | nullish; /** * An array of field names used in the PopupTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Indicates whether actions should replace existing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions popup actions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#overwriteActions Read more...} */ overwriteActions?: boolean; /** * Indicates whether to include the feature's geometry for use by the template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * The template for defining how to format the title used in a popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#title Read more...} */ title?: string | Function | Promise; } export interface Portal extends Accessor, Loadable { } export class Portal { /** * The access level of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#access Read more...} */ access: "public" | "private" | nullish; /** * When `true`, access to the organization's Portal resources must occur over SSL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#allSSL Read more...} */ allSSL: boolean; /** * The authentication mode for handling authentication when the user attempts to * access a secure resource. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#authMode Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#authorizedCrossOriginDomains Read more...} */ authorizedCrossOriginDomains: string[] | nullish; /** * The query that defines the basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps useVectorBasemaps} is not true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery Read more...} */ basemapGalleryGroupQuery: string | nullish; /** * The query that defines the 3D basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery3D Read more...} */ basemapGalleryGroupQuery3D: string | nullish; /** * The Bing key to use for web maps using Bing Maps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#bingKey Read more...} */ bingKey: string | nullish; /** * Indicates whether an organization can list applications in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListApps Read more...} */ canListApps: boolean; /** * Indicates whether an organization can list data services in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListData Read more...} */ canListData: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListPreProvisionedItems Read more...} */ canListPreProvisionedItems: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canProvisionDirectPurchase Read more...} */ canProvisionDirectPurchase: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSearchPublic Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canShareBingPublic Read more...} */ canShareBingPublic: boolean; /** * When `true`, members of the organization can share resources outside the organization. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSharePublic Read more...} */ canSharePublic: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the GeoScene sign in. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSignInGeoScene Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSignInIDP Read more...} */ canSignInIDP: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#colorSetsGroupQuery Read more...} */ colorSetsGroupQuery: string | nullish; /** * Indicates whether to allow the organization to disable commenting. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#commentsEnabled Read more...} */ commentsEnabled: boolean; /** * The default locale (language and country) information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#culture Read more...} */ culture: string | nullish; /** * The custom base URL for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#customBaseUrl Read more...} */ customBaseUrl: string | nullish; /** * The query that defines the default 3d basemap to use in scene views for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#default3DBasemapQuery Read more...} */ default3DBasemapQuery: string | nullish; /** * The default basemap to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultBasemap Read more...} */ defaultBasemap: Basemap | nullish; /** * The default developer basemap to use for the portal when an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#apiKey apiKey} is defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultDevBasemap Read more...} */ defaultDevBasemap: Basemap | nullish; /** * The default vector basemap to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultVectorBasemap Read more...} */ defaultVectorBasemap: Basemap | nullish; /** * A description of the organization/portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#description Read more...} */ description: string | nullish; /** * The query that defines the basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#apiKey apiKey} is defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#devBasemapGalleryGroupQuery Read more...} */ devBasemapGalleryGroupQuery: string | nullish; /** * Boolean value. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#eueiEnabled Read more...} */ eueiEnabled: boolean | nullish; /** * The featured groups for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#featuredGroups Read more...} */ featuredGroups: PortalFeaturedGroups[] | nullish; /** * The query that defines the featured group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#featuredItemsGroupQuery Read more...} */ featuredItemsGroupQuery: string | nullish; /** * The query that identifies the group containing features items for the gallery. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#galleryTemplatesGroupQuery Read more...} */ galleryTemplatesGroupQuery: string | nullish; /** * Indicates whether the organization has content categories. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#hasCategorySchema Read more...} */ hasCategorySchema: boolean; /** * Indicates whether the organization has classification schema. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#hasClassificationSchema Read more...} */ hasClassificationSchema: boolean; /** * This class contains properties to obtain information for various web services available on the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#helperServices Read more...} */ helperServices: any | nullish; /** * The group that contains featured content to be displayed on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#homePageFeaturedContent Read more...} */ homePageFeaturedContent: string | nullish; /** * The number of featured items that can be displayed on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#homePageFeaturedContentCount Read more...} */ homePageFeaturedContentCount: number | nullish; /** * The port used by the portal for HTTP communication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#httpPort Read more...} */ httpPort: number | nullish; /** * The port used by the portal for HTTPS communication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#httpsPort Read more...} */ httpsPort: number | nullish; /** * The id of the organization that owns this portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#id Read more...} */ id: string | nullish; /** * The country code of the calling IP (GeoScene Online only). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#ipCntryCode Read more...} */ ipCntryCode: string | nullish; /** * Indicates whether the portal is an organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isOrganization Read more...} */ readonly isOrganization: boolean; /** * Indicates if the portal is on-premises. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isPortal Read more...} */ isPortal: boolean; /** * Indicates if the portal is in read-only mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isReadOnly Read more...} */ isReadOnly: boolean; /** * The query that identifies the group containing editing templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#layerTemplatesGroupQuery Read more...} */ layerTemplatesGroupQuery: string | nullish; /** * Indicates whether the portal's resources have loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The maximum validity in minutes of tokens issued for users of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#maxTokenExpirationMinutes Read more...} */ maxTokenExpirationMinutes: number | nullish; /** * Name of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#name Read more...} */ name: string | nullish; /** * URL of the portal host. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalHostname Read more...} */ portalHostname: string | nullish; /** * The portal mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalMode Read more...} */ portalMode: "multitenant" | "singletenant" | nullish; /** * Properties specific to the organization, for example the "contact us" link. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalProperties Read more...} */ portalProperties: any; /** * Indicates whether the recycle bin is enabled for the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#recycleBinEnabled Read more...} */ recycleBinEnabled: boolean; /** * The region for the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#region Read more...} */ region: string | nullish; /** * The REST URL for the portal, for example "https://www.geosceneonline.cn/geoscene/sharing/rest" for GeoScene Online * and "https://www.example.com/geoscene/sharing/rest" for your in-house portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#restUrl Read more...} */ readonly restUrl: string; /** * Custom HTML for the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#rotatorPanels Read more...} */ rotatorPanels: any[] | nullish; /** * Indicates whether the description of your organization displays on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#showHomePageDescription Read more...} */ showHomePageDescription: boolean; /** * The JSON used to create the property values when the `Portal` is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#sourceJSON Read more...} */ sourceJSON: any; /** * Indicates whether hosted services are supported. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#supportsHostedServices Read more...} */ supportsHostedServices: boolean; /** * The query that defines the symbols sets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#symbolSetsGroupQuery Read more...} */ symbolSetsGroupQuery: string | nullish; /** * The query that defines the collection of templates that will appear in the template * gallery. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#templatesGroupQuery Read more...} */ templatesGroupQuery: string | nullish; /** * The URL to the thumbnail of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#thumbnailUrl Read more...} */ readonly thumbnailUrl: string | nullish; /** * Sets the units of measure for the organization's users. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#units Read more...} */ units: "english" | "metric" | nullish; /** * The URL to the portal instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#url Read more...} */ url: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#urlKey Read more...} */ urlKey: string | nullish; /** * When `false`, 3D basemaps are hidden from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}, regardless * of the type of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#use3dBasemaps Read more...} */ use3dBasemaps: boolean; /** * When `false`, The default 3d basemap is not used in the SceneViewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useDefault3dBasemap Read more...} */ useDefault3dBasemap: boolean; /** * Information representing a registered user of the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#user Read more...} */ user: PortalUser | nullish; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useStandardizedQuery Read more...} */ useStandardizedQuery: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, * and (a) {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#vectorBasemapGalleryGroupQuery vectorBasemapGalleryGroupQuery} should * be used instead of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery basemapGalleryGroupQuery}, while * (b) {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultVectorBasemap defaultVectorBasemap} should be used instead of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultBasemap defaultBasemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps Read more...} */ useVectorBasemaps: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps useVectorBasemaps} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#vectorBasemapGalleryGroupQuery Read more...} */ vectorBasemapGalleryGroupQuery: string | nullish; /** * The Portal class is part of the [GeoScene Enterprise portal](https://enterprise.geosceneonline.cn/zh/portal/) * that provides a way to build applications that work with content from [GeoScene Online](https://www.geosceneonline.cn/geoscene/home/) or * an [GeoScene Enterprise portal](https://enterprise.geosceneonline.cn/zh/portal/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Read more...} */ constructor(properties?: PortalProperties); /** * Date the organization was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); /** * The default extent to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultExtent Read more...} */ get defaultExtent(): Extent | nullish; set defaultExtent(value: ExtentProperties | nullish); /** * Date the organization was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#modified Read more...} */ get modified(): Date | nullish; set modified(value: DateProperties | nullish); /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#cancelLoad Read more...} */ cancelLoad(): void; /** * A helper function that returns an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationsLayers} * derived from the Portal's [Limited Error Raster Compression (LERC) elevation helper service](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/about-utility-services.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#createElevationLayers Read more...} */ createElevationLayers(): Promise; /** * Fetches the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html basemaps} that are displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}. * * @param basemapGalleryGroupQuery When provided, this argument is used to fetch basemaps based on input query parameters. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchBasemaps Read more...} */ fetchBasemaps(basemapGalleryGroupQuery?: string, options?: PortalFetchBasemapsOptions | null): Promise; /** * If present, fetches the organization's category schema. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchCategorySchema Read more...} */ fetchCategorySchema(options?: PortalFetchCategorySchemaOptions | null): Promise; /** * If present, fetches the organization's classification schema. * * @param options An object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchClassificationSchema Read more...} */ fetchClassificationSchema(options?: PortalFetchClassificationSchemaOptions | null): Promise; /** * Fetches the default 3d {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} to use in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} for this portal. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchDefault3DBasemap Read more...} */ fetchDefault3DBasemap(options?: PortalFetchDefault3DBasemapOptions): Promise; /** * Fetches the featured groups in the Portal. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchFeaturedGroups Read more...} */ fetchFeaturedGroups(options?: PortalFetchFeaturedGroupsOptions | null): Promise; /** * Fetches and returns the associated regions with the portal instance. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchRegions Read more...} */ fetchRegions(options?: PortalFetchRegionsOptions | null): Promise; /** * Fetches and returns the portal settings as seen by the current user(s), whether anonymous or signed in. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#fetchSettings Read more...} */ fetchSettings(options?: PortalFetchSettingsOptions | null): Promise; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Executes a query against the Portal to return an array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html PortalGroup} objects that match the input query. * * @param queryParams The input query parameters defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html PortalQueryParams}. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#queryGroups Read more...} */ queryGroups(queryParams: PortalQueryParamsProperties, options?: PortalQueryGroupsOptions | null): Promise; /** * Executes a query against the Portal to return an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItem} * objects that match the input query. * * @param queryParams The input query parameters defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html PortalQueryParams}. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#queryItems Read more...} */ queryItems(queryParams: PortalQueryParamsProperties, options?: PortalQueryItemsOptions | null): Promise; /** * Executes a query against the Portal to return an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html PortalUser} * objects that match the input query. * * @param queryParams The input query parameters defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html PortalQueryParams}. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#queryUsers Read more...} */ queryUsers(queryParams: PortalQueryParamsProperties, options?: PortalQueryUsersOptions | null): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * A new `Portal` instance is created the first time this method is called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#getDefault Read more...} */ static getDefault(): Portal; } interface PortalProperties extends LoadableProperties { /** * The access level of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#access Read more...} */ access?: "public" | "private" | nullish; /** * When `true`, access to the organization's Portal resources must occur over SSL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#allSSL Read more...} */ allSSL?: boolean; /** * The authentication mode for handling authentication when the user attempts to * access a secure resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#authMode Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#authorizedCrossOriginDomains Read more...} */ authorizedCrossOriginDomains?: string[] | nullish; /** * The query that defines the basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps useVectorBasemaps} is not true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery Read more...} */ basemapGalleryGroupQuery?: string | nullish; /** * The query that defines the 3D basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery3D Read more...} */ basemapGalleryGroupQuery3D?: string | nullish; /** * The Bing key to use for web maps using Bing Maps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#bingKey Read more...} */ bingKey?: string | nullish; /** * Indicates whether an organization can list applications in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListApps Read more...} */ canListApps?: boolean; /** * Indicates whether an organization can list data services in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListData Read more...} */ canListData?: boolean; /** * Indicates whether an organization can list pre-provisioned items in the marketplace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canListPreProvisionedItems Read more...} */ canListPreProvisionedItems?: boolean; /** * Indicates whether an organization can provision direct purchases in the marketplace without customer request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canProvisionDirectPurchase Read more...} */ canProvisionDirectPurchase?: boolean; /** * When `true`, the organization's public items, groups and users are included in search queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSearchPublic Read more...} */ 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/`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canShareBingPublic Read more...} */ canShareBingPublic?: boolean; /** * When `true`, members of the organization can share resources outside the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSharePublic Read more...} */ canSharePublic?: boolean; /** * Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the GeoScene sign in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSignInGeoScene Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#canSignInIDP Read more...} */ canSignInIDP?: boolean; /** * The query that identifies the group containing the color sets used for rendering in the map viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#colorSetsGroupQuery Read more...} */ colorSetsGroupQuery?: string | nullish; /** * Indicates whether to allow the organization to disable commenting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#commentsEnabled Read more...} */ commentsEnabled?: boolean; /** * Date the organization was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#created Read more...} */ created?: DateProperties | nullish; /** * The default locale (language and country) information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#culture Read more...} */ culture?: string | nullish; /** * The custom base URL for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#customBaseUrl Read more...} */ customBaseUrl?: string | nullish; /** * The query that defines the default 3d basemap to use in scene views for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#default3DBasemapQuery Read more...} */ default3DBasemapQuery?: string | nullish; /** * The default basemap to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultBasemap Read more...} */ defaultBasemap?: Basemap | nullish; /** * The default developer basemap to use for the portal when an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#apiKey apiKey} is defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultDevBasemap Read more...} */ defaultDevBasemap?: Basemap | nullish; /** * The default extent to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultExtent Read more...} */ defaultExtent?: ExtentProperties | nullish; /** * The default vector basemap to use for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultVectorBasemap Read more...} */ defaultVectorBasemap?: Basemap | nullish; /** * A description of the organization/portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#description Read more...} */ description?: string | nullish; /** * The query that defines the basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-config.html#apiKey apiKey} is defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#devBasemapGalleryGroupQuery Read more...} */ devBasemapGalleryGroupQuery?: string | nullish; /** * Boolean value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#eueiEnabled Read more...} */ eueiEnabled?: boolean | nullish; /** * The featured groups for the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#featuredGroups Read more...} */ featuredGroups?: PortalFeaturedGroups[] | nullish; /** * The query that defines the featured group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#featuredItemsGroupQuery Read more...} */ featuredItemsGroupQuery?: string | nullish; /** * The query that identifies the group containing features items for the gallery. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#galleryTemplatesGroupQuery Read more...} */ galleryTemplatesGroupQuery?: string | nullish; /** * Indicates whether the organization has content categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#hasCategorySchema Read more...} */ hasCategorySchema?: boolean; /** * Indicates whether the organization has classification schema. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#hasClassificationSchema Read more...} */ hasClassificationSchema?: boolean; /** * This class contains properties to obtain information for various web services available on the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#helperServices Read more...} */ helperServices?: any | nullish; /** * The group that contains featured content to be displayed on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#homePageFeaturedContent Read more...} */ homePageFeaturedContent?: string | nullish; /** * The number of featured items that can be displayed on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#homePageFeaturedContentCount Read more...} */ homePageFeaturedContentCount?: number | nullish; /** * The port used by the portal for HTTP communication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#httpPort Read more...} */ httpPort?: number | nullish; /** * The port used by the portal for HTTPS communication. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#httpsPort Read more...} */ httpsPort?: number | nullish; /** * The id of the organization that owns this portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#id Read more...} */ id?: string | nullish; /** * The country code of the calling IP (GeoScene Online only). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#ipCntryCode Read more...} */ ipCntryCode?: string | nullish; /** * Indicates if the portal is on-premises. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isPortal Read more...} */ isPortal?: boolean; /** * Indicates if the portal is in read-only mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#isReadOnly Read more...} */ isReadOnly?: boolean; /** * The query that identifies the group containing editing templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#layerTemplatesGroupQuery Read more...} */ layerTemplatesGroupQuery?: string | nullish; /** * The maximum validity in minutes of tokens issued for users of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#maxTokenExpirationMinutes Read more...} */ maxTokenExpirationMinutes?: number | nullish; /** * Date the organization was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#modified Read more...} */ modified?: DateProperties | nullish; /** * Name of the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#name Read more...} */ name?: string | nullish; /** * URL of the portal host. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalHostname Read more...} */ portalHostname?: string | nullish; /** * The portal mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalMode Read more...} */ portalMode?: "multitenant" | "singletenant" | nullish; /** * Properties specific to the organization, for example the "contact us" link. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#portalProperties Read more...} */ portalProperties?: any; /** * Indicates whether the recycle bin is enabled for the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#recycleBinEnabled Read more...} */ recycleBinEnabled?: boolean; /** * The region for the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#region Read more...} */ region?: string | nullish; /** * Custom HTML for the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#rotatorPanels Read more...} */ rotatorPanels?: any[] | nullish; /** * Indicates whether the description of your organization displays on the home page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#showHomePageDescription Read more...} */ showHomePageDescription?: boolean; /** * The JSON used to create the property values when the `Portal` is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#sourceJSON Read more...} */ sourceJSON?: any; /** * Indicates whether hosted services are supported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#supportsHostedServices Read more...} */ supportsHostedServices?: boolean; /** * The query that defines the symbols sets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#symbolSetsGroupQuery Read more...} */ symbolSetsGroupQuery?: string | nullish; /** * The query that defines the collection of templates that will appear in the template * gallery. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#templatesGroupQuery Read more...} */ templatesGroupQuery?: string | nullish; /** * Sets the units of measure for the organization's users. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#units Read more...} */ units?: "english" | "metric" | nullish; /** * The URL to the portal instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#url Read more...} */ url?: string; /** * The prefix selected by the organization's administrator to be used with the customBaseURL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#urlKey Read more...} */ urlKey?: string | nullish; /** * When `false`, 3D basemaps are hidden from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}, regardless * of the type of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#use3dBasemaps Read more...} */ use3dBasemaps?: boolean; /** * When `false`, The default 3d basemap is not used in the SceneViewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useDefault3dBasemap Read more...} */ useDefault3dBasemap?: boolean; /** * Information representing a registered user of the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#user Read more...} */ user?: PortalUser | nullish; /** * When `true`, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useStandardizedQuery Read more...} */ useStandardizedQuery?: boolean; /** * When `true`, the organization has opted in to use the vector tile basemaps, * and (a) {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#vectorBasemapGalleryGroupQuery vectorBasemapGalleryGroupQuery} should * be used instead of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#basemapGalleryGroupQuery basemapGalleryGroupQuery}, while * (b) {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultVectorBasemap defaultVectorBasemap} should be used instead of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#defaultBasemap defaultBasemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps Read more...} */ useVectorBasemaps?: boolean; /** * The query that defines the vector tiles basemaps that should be displayed in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#useVectorBasemaps useVectorBasemaps} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#vectorBasemapGalleryGroupQuery Read more...} */ vectorBasemapGalleryGroupQuery?: string | nullish; } export interface PortalFeaturedGroups { owner: string; title: string; } export interface PortalFetchBasemapsOptions { signal?: AbortSignal | nullish; include3d?: boolean; } export interface PortalFetchCategorySchemaOptions { signal?: AbortSignal | nullish; } export interface PortalFetchClassificationSchemaOptions { signal?: AbortSignal | nullish; } export interface PortalFetchDefault3DBasemapOptions { signal?: AbortSignal | nullish; } export interface PortalFetchFeaturedGroupsOptions { signal?: AbortSignal | nullish; } export interface PortalFetchRegionsOptions { signal?: AbortSignal | nullish; } export interface PortalFetchSettingsOptions { signal?: AbortSignal | nullish; } export interface PortalQueryGroupsOptions { signal?: AbortSignal | nullish; } export interface PortalQueryItemsOptions { signal?: AbortSignal | nullish; } export interface PortalQueryUsersOptions { signal?: AbortSignal | nullish; } export class PortalFolder extends Accessor { /** * The unique id of the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#id Read more...} */ id: string; /** * The portal associated with the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#portal Read more...} */ portal: Portal | nullish; /** * The title of the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#title Read more...} */ title: string | nullish; /** * The URL to the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#url Read more...} */ readonly url: string | nullish; /** * Provides information about folders used to organize content in a portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html Read more...} */ constructor(properties?: PortalFolderProperties); /** * The date the folder was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); } interface PortalFolderProperties { /** * The date the folder was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#created Read more...} */ created?: DateProperties | nullish; /** * The unique id of the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#id Read more...} */ id?: string; /** * The portal associated with the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#portal Read more...} */ portal?: Portal | nullish; /** * The title of the folder. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalFolder.html#title Read more...} */ title?: string | nullish; } export class PortalGroup extends Accessor { /** * The access privileges on the group which determines who can see and access the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#access Read more...} */ access: "private" | "org" | "public" | nullish; /** * A detailed description of the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#description Read more...} */ description: string | nullish; /** * The unique id for the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#id Read more...} */ id: string | nullish; /** * If set to `true`, then users will not be able to apply to join the group. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#isInvitationOnly Read more...} */ isInvitationOnly: boolean; /** * The username of the group's owner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#owner Read more...} */ owner: string | nullish; /** * The portal associated with the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#portal Read more...} */ portal: Portal | nullish; /** * A short summary that describes the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#snippet Read more...} */ snippet: string | nullish; /** * The JSON used to create the property values when the `PortalGroup` is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#sourceJSON Read more...} */ sourceJSON: any; /** * User defined tags that describe the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#tags Read more...} */ tags: string[] | nullish; /** * The URL to the thumbnail used for the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#thumbnailUrl Read more...} */ readonly thumbnailUrl: string | nullish; /** * The title of the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#title Read more...} */ title: string | nullish; /** * The URL to the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#url Read more...} */ readonly url: string | nullish; /** * The group resource represents a group within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html Read more...} */ constructor(properties?: PortalGroupProperties); /** * The date the group was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); /** * The date the group was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#modified Read more...} */ get modified(): Date | nullish; set modified(value: DateProperties | nullish); /** * If present, fetches the group's category schema. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#fetchCategorySchema Read more...} */ fetchCategorySchema(options?: PortalGroupFetchCategorySchemaOptions | null): Promise; /** * Fetches the current members of the group. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#fetchMembers Read more...} */ fetchMembers(options?: PortalGroupFetchMembersOptions | null): Promise; /** * Get the URL to the thumbnail image for the group. * * @param width The desired image width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#getThumbnailUrl Read more...} */ getThumbnailUrl(width?: number): string | nullish; /** * Executes a query against the group to return an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItem} objects * that match the input query. * * @param queryParams The input query parameters defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html PortalQueryParams}. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#queryItems Read more...} */ queryItems(queryParams?: PortalQueryParamsProperties, options?: PortalGroupQueryItemsOptions | null): Promise; } interface PortalGroupProperties { /** * The access privileges on the group which determines who can see and access the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#access Read more...} */ access?: "private" | "org" | "public" | nullish; /** * The date the group was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#created Read more...} */ created?: DateProperties | nullish; /** * A detailed description of the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#description Read more...} */ description?: string | nullish; /** * The unique id for the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#id Read more...} */ id?: string | nullish; /** * If set to `true`, then users will not be able to apply to join the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#isInvitationOnly Read more...} */ isInvitationOnly?: boolean; /** * The date the group was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#modified Read more...} */ modified?: DateProperties | nullish; /** * The username of the group's owner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#owner Read more...} */ owner?: string | nullish; /** * The portal associated with the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#portal Read more...} */ portal?: Portal | nullish; /** * A short summary that describes the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#snippet Read more...} */ snippet?: string | nullish; /** * The JSON used to create the property values when the `PortalGroup` is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#sourceJSON Read more...} */ sourceJSON?: any; /** * User defined tags that describe the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#tags Read more...} */ tags?: string[] | nullish; /** * The title of the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#title Read more...} */ title?: string | nullish; } /** * Members returned in the result of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#fetchMembers fetchMembers()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalGroup.html#Members Read more...} */ export interface Members { admins: string[]; owner: string; users: string[]; } export interface PortalGroupFetchCategorySchemaOptions { signal?: AbortSignal | nullish; } export interface PortalGroupFetchMembersOptions { signal?: AbortSignal | nullish; } export interface PortalGroupQueryItemsOptions { signal?: AbortSignal | nullish; } export interface PortalItem extends Accessor, Loadable, JSONSupport { } export class PortalItem { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#access Read more...} */ access: "private" | "shared" | "org" | "public"; /** * Information on the source of the item and its copyright status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#accessInformation Read more...} */ accessInformation: string | nullish; /** * An authorization string used to access the portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#apiKey Read more...} */ apiKey: string | nullish; /** * Contains an array of objects containing proxy information for premium platform services. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#applicationProxies Read more...} */ readonly applicationProxies: PortalItemApplicationProxies[] | nullish; /** * Average rating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#avgRating Read more...} */ avgRating: number | nullish; /** * An array of organization categories that are set on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#categories Read more...} */ categories: string[] | nullish; /** * The classification information for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#classification Read more...} */ classification: HashMap | nullish; /** * The item's locale information (language and country). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#culture Read more...} */ culture: string | nullish; /** * The detailed description of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#description Read more...} */ description: string | nullish; /** * An array of group categories set on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#groupCategories Read more...} */ groupCategories: string[] | nullish; /** * The unique id for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#id Read more...} */ id: string | nullish; /** * Indicates whether a layer can be created from this item using [Layer.fromPortalItem()](geoscene-layers-Layer.html#fromPortalItem). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#isLayer Read more...} */ readonly isLayer: boolean; /** * Indicates whether this item and the user whose credential was used to fetch this item belong * to the same GeoScene Enterprise Portal or GeoScene Online Organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#isOrgItem Read more...} */ readonly isOrgItem: boolean; /** * Indicates whether an item can be updated and deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#itemControl Read more...} */ readonly itemControl: "admin" | "update" | "null" | nullish; /** * The URL to the [Item page](https://doc.geoscene.cn/geoscene-online/manage-data/item-details.htm) on the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#itemPageUrl Read more...} */ readonly itemPageUrl: string | nullish; /** * The URL to the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#itemUrl Read more...} */ readonly itemUrl: string | nullish; /** * Information on license or restrictions related to the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#licenseInfo Read more...} */ licenseInfo: string | nullish; /** * Indicates whether the item's resources have loaded from the portal. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#loadError Read more...} */ declare readonly loadError: Loadable["loadError"]; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#loadStatus Read more...} */ declare readonly loadStatus: Loadable["loadStatus"]; /** * A list of warnings which occurred while loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#loadWarnings Read more...} */ declare readonly loadWarnings: Loadable["loadWarnings"]; /** * The name of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#name Read more...} */ name: string | nullish; /** * Number of comments on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numComments Read more...} */ numComments: number | nullish; /** * Number of ratings on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numRatings Read more...} */ numRatings: number | nullish; /** * Number of views on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numViews Read more...} */ numViews: number | nullish; /** * The username of the user who owns this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#owner Read more...} */ owner: string | nullish; /** * The ID of the folder in which the owner has stored the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#ownerFolder Read more...} */ ownerFolder: string | nullish; /** * An array of string URLs. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#screenshots Read more...} */ screenshots: string[] | nullish; /** * The size of the item (in bytes). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#size Read more...} */ size: number | nullish; /** * A summary description of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#snippet Read more...} */ snippet: string | nullish; /** * The JSON used to create the property values when the `PortalItem` is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#sourceJSON Read more...} */ sourceJSON: any; /** * User defined tags that describe the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#tags Read more...} */ tags: string[] | nullish; /** * The URL to the thumbnail used for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#thumbnailUrl Read more...} */ readonly thumbnailUrl: string | nullish; /** * The title for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#title Read more...} */ title: string | nullish; /** * The GIS content type of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#type Read more...} */ type: string | nullish; /** * Type keywords that describe the type of content of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#typeKeywords Read more...} */ typeKeywords: string[]; /** * The service URL of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#url Read more...} */ url: string | nullish; /** * An item (a unit of content) in the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html Read more...} */ constructor(properties?: PortalItemProperties); /** * The date the item was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); /** * The geographic extent, or bounding rectangle, of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * The date the item was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#modified Read more...} */ get modified(): Date | nullish; set modified(value: DateProperties | nullish); /** * The portal that contains the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#portal Read more...} */ get portal(): Portal; set portal(value: PortalProperties); /** * Adds a rating to an accessible item. * * @param rating Rating to set for the item. Rating must be a number between 1.0 and 5.0. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#addRating Read more...} */ addRating(rating: number | PortalRating): Promise; /** * Adds a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html resource} to the portal item. * * @param resource The resource to add to the portal item. * @param content The resource content. * @param options An object wih the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#addResource Read more...} */ addResource(resource: PortalItemResource, content: Blob, options?: PortalItemAddResourceOptions): Promise; /** * Cancels a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#load load()} operation if it is already in progress. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#cancelLoad Read more...} */ cancelLoad(): void; /** * Creates a clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#clone Read more...} */ clone(): PortalItem; /** * Deletes a rating for the specified item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#deleteRating Read more...} */ deleteRating(): Promise; /** * Destroys the portal item, and any associated resources, including its associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#portal portal}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#destroy Read more...} */ destroy(): void; /** * Requests a PortalItem in the format specified in `responseType`. * * @param responseType The format of the response. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchData Read more...} */ fetchData(responseType?: "json" | "xml" | "text" | "blob" | "array-buffer" | "document", options?: PortalItemFetchDataOptions | null): Promise; /** * Returns the rating (if any) given to the item. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchRating Read more...} */ fetchRating(options?: PortalItemFetchRatingOptions): Promise; /** * Gets all the related items of a certain relationship type for the portal item. * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchRelatedItems Read more...} */ fetchRelatedItems(params: PortalItemFetchRelatedItemsParams, options?: PortalItemFetchRelatedItemsOptions | null): Promise; /** * Retrieves references to all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html portal item resources}. * * @param params The fetch parameters used to retrieve {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html portal item resources}. * @param options Additional options with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchResources Read more...} */ fetchResources(params?: FetchResourcesParams, options?: PortalItemFetchResourcesOptions | null): Promise; /** * Get the URL to the thumbnail image for the item. * * @param width The desired image width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#getThumbnailUrl Read more...} */ getThumbnailUrl(width?: number): string | nullish; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#isResolved Read more...} */ isResolved(): boolean; /** * Loads the resources referenced by this class. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#load Read more...} */ load(options?: LoadableLoadOptions | nullish): Promise; /** * Reloads a loaded item's properties from the portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#reload Read more...} */ reload(): Promise; /** * Removes all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html resources} from the portal item. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#removeAllResources Read more...} */ removeAllResources(options?: PortalItemRemoveAllResourcesOptions): Promise; /** * Removes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html resource} from the portal item. * * @param resource The resource to remove from the portal item. * @param options An object wih the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#removeResource Read more...} */ removeResource(resource: PortalItemResource, options?: PortalItemRemoveResourceOptions): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#toJSON Read more...} */ toJSON(): any; /** * Updates the item's properties to the portal, and optionally its data. * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#update Read more...} */ update(params?: PortalItemUpdateParams): Promise; /** * Updates the item's thumbnail on the portal. * * @param params See the object specification table below for the parameters that may be passed as properties in this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#updateThumbnail Read more...} */ updateThumbnail(params: PortalItemUpdateThumbnailParams): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PortalItem; } interface PortalItemProperties extends LoadableProperties { /** * Indicates the level of access to this item: `private`, `shared`, `org`, or `public`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#access Read more...} */ access?: "private" | "shared" | "org" | "public"; /** * Information on the source of the item and its copyright status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#accessInformation Read more...} */ accessInformation?: string | nullish; /** * An authorization string used to access the portal item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#apiKey Read more...} */ apiKey?: string | nullish; /** * Average rating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#avgRating Read more...} */ avgRating?: number | nullish; /** * An array of organization categories that are set on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#categories Read more...} */ categories?: string[] | nullish; /** * The classification information for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#classification Read more...} */ classification?: HashMap | nullish; /** * The date the item was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#created Read more...} */ created?: DateProperties | nullish; /** * The item's locale information (language and country). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#culture Read more...} */ culture?: string | nullish; /** * The detailed description of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#description Read more...} */ description?: string | nullish; /** * The geographic extent, or bounding rectangle, of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * An array of group categories set on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#groupCategories Read more...} */ groupCategories?: string[] | nullish; /** * The unique id for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#id Read more...} */ id?: string | nullish; /** * Information on license or restrictions related to the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#licenseInfo Read more...} */ licenseInfo?: string | nullish; /** * The date the item was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#modified Read more...} */ modified?: DateProperties | nullish; /** * The name of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#name Read more...} */ name?: string | nullish; /** * Number of comments on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numComments Read more...} */ numComments?: number | nullish; /** * Number of ratings on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numRatings Read more...} */ numRatings?: number | nullish; /** * Number of views on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#numViews Read more...} */ numViews?: number | nullish; /** * The username of the user who owns this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#owner Read more...} */ owner?: string | nullish; /** * The ID of the folder in which the owner has stored the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#ownerFolder Read more...} */ ownerFolder?: string | nullish; /** * The portal that contains the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#portal Read more...} */ portal?: PortalProperties; /** * An array of string URLs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#screenshots Read more...} */ screenshots?: string[] | nullish; /** * The size of the item (in bytes). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#size Read more...} */ size?: number | nullish; /** * A summary description of the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#snippet Read more...} */ snippet?: string | nullish; /** * The JSON used to create the property values when the `PortalItem` is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#sourceJSON Read more...} */ sourceJSON?: any; /** * User defined tags that describe the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#tags Read more...} */ tags?: string[] | nullish; /** * The title for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#title Read more...} */ title?: string | nullish; /** * The GIS content type of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#type Read more...} */ type?: string | nullish; /** * Type keywords that describe the type of content of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#typeKeywords Read more...} */ typeKeywords?: string[]; /** * The service URL of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#url Read more...} */ url?: string | nullish; } /** * A resource reference returned in the result of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchResources fetchResources()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#FetchResource Read more...} */ export interface FetchResource { resource: PortalItemResource; created: Date; size: number; } /** * Parameters used when fetching portal item resources using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchResources fetchResources()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#FetchResourcesParams Read more...} */ export interface FetchResourcesParams { num?: number; start?: number; sortOrder?: "asc" | "desc"; sortField?: "created" | "size" | "resource"; } /** * Object returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#fetchResources fetchResources()} promise resolves. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html#FetchResourcesResult Read more...} */ export interface FetchResourcesResult { resources: FetchResource[]; nextStart: number; total: number; } export interface PortalItemAddResourceOptions { access?: "inherit" | "private"; signal?: AbortSignal | nullish; } export interface PortalItemApplicationProxies { sourceUrl: string; proxyUrl: string; proxyId: string; } export interface PortalItemFetchDataOptions { signal?: AbortSignal | nullish; } export interface PortalItemFetchRatingOptions { signal?: AbortSignal | nullish; } export interface PortalItemFetchRelatedItemsOptions { signal?: AbortSignal | nullish; } export interface PortalItemFetchRelatedItemsParams { relationshipType: string; direction: "forward" | "reverse"; } export interface PortalItemFetchResourcesOptions { signal?: AbortSignal | nullish; } export interface PortalItemRemoveAllResourcesOptions { signal?: AbortSignal | nullish; } export interface PortalItemRemoveResourceOptions { signal?: AbortSignal | nullish; } export interface PortalItemUpdateParams { data?: string | any; } export interface PortalItemUpdateThumbnailParams { thumbnail: Blob | string; filename?: string; } export class PortalItemResource extends Accessor { /** * Path of the resource relative to `{ITEM}/resources/`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#path Read more...} */ path: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} that owns the resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#portalItem Read more...} */ portalItem: PortalItem; /** * The absolute url to the item resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#url Read more...} */ readonly url: string | nullish; /** * A reference to a portal item resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html Read more...} */ constructor(properties?: PortalItemResourceProperties); /** * Requests the PortalItemResource data in the format specified for the `responseType`. * * @param responseType The format of the response. * @param options An object wih the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#fetch Read more...} */ fetch(responseType?: "json" | "xml" | "text" | "blob" | "array-buffer" | "document", options?: PortalItemResourceFetchOptions | null): Promise; /** * Updates an existing resource with new content. * * @param content The resource content. * @param options An object wih the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#update Read more...} */ update(content: Blob, options?: PortalItemResourceUpdateOptions): Promise; } interface PortalItemResourceProperties { /** * Path of the resource relative to `{ITEM}/resources/`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#path Read more...} */ path?: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} that owns the resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItemResource.html#portalItem Read more...} */ portalItem?: PortalItem; } export interface PortalItemResourceFetchOptions { cacheBust?: boolean; signal?: AbortSignal | nullish; } export interface PortalItemResourceUpdateOptions { access?: "inherit" | "private"; signal?: AbortSignal | nullish; } export class PortalQueryParams extends Accessor { /** * An array of categories stored within the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#categories Read more...} */ categories: (string | string[])[] | nullish; /** * Structured filter to use instead of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#query query} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#filter Read more...} */ filter: string | nullish; /** * The maximum number of results to be included in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#results result} set response. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#num Read more...} */ num: number; /** * The query string used for the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#query Read more...} */ query: string | nullish; /** * A comma-delimited list of fields to sort. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#sortField Read more...} */ sortField: | "title" | "uploaded" | "modified" | "username" | "created" | "type" | "owner" | "avg-rating" | "num-ratings" | "num-comments" | "num-views" | nullish; /** * The order in which to sort the results. * * @default "asc" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#sortOrder Read more...} */ sortOrder: "asc" | "desc"; /** * The index of the first entry in the result set response. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#start Read more...} */ start: number; /** * The parameters used to perform a query for Items, Groups, and Users within a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html Read more...} */ constructor(properties?: PortalQueryParamsProperties); /** * Only relevant when querying for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItems}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * Creates a deep clone of the instance of PortalQueryParams that calls this method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#clone Read more...} */ clone(): PortalQueryParams; } interface PortalQueryParamsProperties { /** * An array of categories stored within the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#categories Read more...} */ categories?: (string | string[])[] | nullish; /** * Only relevant when querying for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItems}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * Structured filter to use instead of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#query query} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#filter Read more...} */ filter?: string | nullish; /** * The maximum number of results to be included in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#results result} set response. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#num Read more...} */ num?: number; /** * The query string used for the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#query Read more...} */ query?: string | nullish; /** * A comma-delimited list of fields to sort. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#sortField Read more...} */ sortField?: | "title" | "uploaded" | "modified" | "username" | "created" | "type" | "owner" | "avg-rating" | "num-ratings" | "num-comments" | "num-views" | nullish; /** * The order in which to sort the results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#sortOrder Read more...} */ sortOrder?: "asc" | "desc"; /** * The index of the first entry in the result set response. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html#start Read more...} */ start?: number; } export class PortalQueryResult extends Accessor { /** * The query parameters for the next set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#nextQueryParams Read more...} */ nextQueryParams: PortalQueryParams | nullish; /** * The query parameters for the first set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#queryParams Read more...} */ queryParams: PortalQueryParams | nullish; /** * An array of result item objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#results Read more...} */ results: any[]; /** * The total number of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#total Read more...} */ total: number; /** * Represents the result object returned from a portal query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html Read more...} */ constructor(properties?: PortalQueryResultProperties); } interface PortalQueryResultProperties { /** * The query parameters for the next set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#nextQueryParams Read more...} */ nextQueryParams?: PortalQueryParams | nullish; /** * The query parameters for the first set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#queryParams Read more...} */ queryParams?: PortalQueryParams | nullish; /** * An array of result item objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#results Read more...} */ results?: any[]; /** * The total number of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryResult.html#total Read more...} */ total?: number; } export class PortalRating extends Accessor { /** * A rating between 1.0 and 5.0 for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalRating.html#rating Read more...} */ rating: number | nullish; /** * PortalRating provides details about the rating associated with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html Portal item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalRating.html Read more...} */ constructor(properties?: PortalRatingProperties); /** * Date the rating was added to the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalRating.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); } interface PortalRatingProperties { /** * Date the rating was added to the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalRating.html#created Read more...} */ created?: DateProperties | nullish; /** * A rating between 1.0 and 5.0 for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalRating.html#rating Read more...} */ rating?: number | nullish; } export class PortalUser extends Accessor { /** * Indicates the level of access of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#access Read more...} */ access: "private" | "org" | "public" | nullish; /** * The culture information for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#culture Read more...} */ culture: string | nullish; /** * A description of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#description Read more...} */ description: string | nullish; /** * The user's e-mail address. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#email Read more...} */ email: string | nullish; /** * The user's full name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fullName Read more...} */ fullName: string | nullish; /** * The unique id for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#id Read more...} */ id: string; /** * The ID of the organization the user belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#orgId Read more...} */ orgId: string | nullish; /** * The portal associated with the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#portal Read more...} */ portal: Portal; /** * The user's preferred view for content, either web or GIS. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#preferredView Read more...} */ preferredView: string | nullish; /** * The user's privileges based on their user type or role in their organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#privileges Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#region Read more...} */ region: string | nullish; /** * Defines the user's role in the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#role Read more...} */ role: "org_admin" | "org_publisher" | "org_user" | nullish; /** * The ID of the user's role. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#roleId Read more...} */ roleId: string | nullish; /** * The JSON used to create the property values when the `PortalUser` is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#sourceJSON Read more...} */ sourceJSON: any; /** * The URL to the thumbnail image for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#thumbnailUrl Read more...} */ readonly thumbnailUrl: string | nullish; /** * The user's personal units of measure setting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#units Read more...} */ units: "english" | "metric" | nullish; /** * The URL for the user's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#userContentUrl Read more...} */ readonly userContentUrl: string | nullish; /** * The username of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#username Read more...} */ username: string; /** * Represents a registered user of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html Portal}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html Read more...} */ constructor(properties?: PortalUserProperties); /** * The date the user was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#created Read more...} */ get created(): Date | nullish; set created(value: DateProperties | nullish); /** * The date the user was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#modified Read more...} */ get modified(): Date | nullish; set modified(value: DateProperties | nullish); /** * Adds an item to the user's portal content. * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#addItem Read more...} */ addItem(params: PortalUserAddItemParams): Promise; /** * Deletes an item from the user's portal content. * * @param item The portal item to remove. * @param permanentDelete **Since 4.30.** When the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#recycleBinEnabled recycle bin is enabled} and the item to be deleted is an item type supported by the recycle bin, this parameter determines if the item should be permanently deleted. If `true`, the item will be permanently deleted. Otherwise, the item will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If the item is not supported by the recycle bin, it will be permanently deleted regardless of the value of this parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#deleteItem Read more...} */ deleteItem(item: PortalItem, permanentDelete?: boolean): Promise; /** * Deletes items from the user's portal content. * * @param items The portal items to remove. * @param permanentDelete **Since 4.30.** When the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-Portal.html#recycleBinEnabled recycle bin is enabled} and the items to be deleted are item types supported by the recycle bin, this parameter determines if the items should be permanently deleted. If `true`, the items will be permanently deleted. Otherwise, the items will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If items are not supported by the recycle bin, they will be permanently deleted regardless of the value of this parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#deleteItems Read more...} */ deleteItems(items: PortalItem[], permanentDelete?: boolean): Promise; /** * Fetches all of the user's folders used to organize portal content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fetchFolders Read more...} */ fetchFolders(): Promise; /** * Fetches all the groups that the portal user has permission to access. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fetchGroups Read more...} */ fetchGroups(): Promise; /** * Retrieves all the items in either the user's root folder or the specified folder. * * @param params See the object specifications table below for the parameters that may be passed as properties in this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fetchItems Read more...} */ fetchItems(params?: PortalUserFetchItemsParams): Promise; /** * Fetches the tag objects that have been created by the portal user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fetchTags Read more...} */ fetchTags(): Promise; /** * Get the URL to the thumbnail image for the user. * * @param width The desired image width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#getThumbnailUrl Read more...} */ getThumbnailUrl(width?: number): string | nullish; /** * Executes a query against the user's favorite group to return an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItem} * objects that match the input query. * * @param queryParams The input query parameters defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalQueryParams.html PortalQueryParams}. This object may be {@link https://doc.geoscene.cn/javascript/4.33/autocasting/ autocast}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#queryFavorites Read more...} */ queryFavorites(queryParams?: PortalQueryParams): Promise; /** * Restores an item from the user's recycle bin to their content. * * @param item The portal item to restore. * @param folder The folder to restore the item to. If not specified, the item will be restored to the root folder. If an invalid folder is specified, an error will be returned and the item will not be restored. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#restoreItem Read more...} */ restoreItem(item: PortalItem, folder?: PortalFolder | string): Promise; } interface PortalUserProperties { /** * Indicates the level of access of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#access Read more...} */ access?: "private" | "org" | "public" | nullish; /** * The date the user was created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#created Read more...} */ created?: DateProperties | nullish; /** * The culture information for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#culture Read more...} */ culture?: string | nullish; /** * A description of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#description Read more...} */ description?: string | nullish; /** * The user's e-mail address. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#email Read more...} */ email?: string | nullish; /** * The user's full name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fullName Read more...} */ fullName?: string | nullish; /** * The unique id for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#id Read more...} */ id?: string; /** * The date the user was last modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#modified Read more...} */ modified?: DateProperties | nullish; /** * The ID of the organization the user belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#orgId Read more...} */ orgId?: string | nullish; /** * The portal associated with the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#portal Read more...} */ portal?: Portal; /** * The user's preferred view for content, either web or GIS. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#preferredView Read more...} */ preferredView?: string | nullish; /** * The user's privileges based on their user type or role in their organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#privileges Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#region Read more...} */ region?: string | nullish; /** * Defines the user's role in the organization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#role Read more...} */ role?: "org_admin" | "org_publisher" | "org_user" | nullish; /** * The ID of the user's role. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#roleId Read more...} */ roleId?: string | nullish; /** * The JSON used to create the property values when the `PortalUser` is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#sourceJSON Read more...} */ sourceJSON?: any; /** * The user's personal units of measure setting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#units Read more...} */ units?: "english" | "metric" | nullish; /** * The username of the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#username Read more...} */ username?: string; } /** * The result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#deleteItems `deleteItems()`} method containing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html item}, if deletion is successful, and error, if any. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#DeleteItemsResult Read more...} */ export interface DeleteItemsResult { item: PortalItem; success: boolean; error?: Error | nullish; } /** * The result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#fetchItems `fetchItems()`} method containing an array of the fetched {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal items}, the next entry index, and the total number of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalUser.html#FetchItemsResult Read more...} */ export interface FetchItemsResult { items: PortalItem[]; nextStart: number; total: number; } export interface PortalUserAddItemParams { item: PortalItem; data?: string | any; folder?: string | PortalFolder; } export interface PortalUserFetchItemsParams { folder?: PortalFolder; inRecycleBin?: boolean; includeSubfolderItems?: boolean; num?: number; sortField?: string; sortOrder?: "asc" | "desc"; start?: number; } /** * A convenience module for importing renderer classes that can be used to render * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes} to import union types, or individual modules to import classes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html Read more...} */ namespace rasterRenderers { /** * FlowRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/FlowRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#FlowRenderer Read more...} */ export type FlowRenderer = __geoscene.FlowRenderer; export const FlowRenderer: typeof __geoscene.FlowRenderer; /** * ClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#ClassBreaksRenderer Read more...} */ export type ClassBreaksRenderer = __geoscene.ClassBreaksRenderer; export const ClassBreaksRenderer: typeof __geoscene.ClassBreaksRenderer; /** * UniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/UniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#UniqueValueRenderer Read more...} */ export type UniqueValueRenderer = __geoscene.UniqueValueRenderer; export const UniqueValueRenderer: typeof __geoscene.UniqueValueRenderer; /** * RasterColormapRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterColormapRenderer Read more...} */ export type RasterColormapRenderer = __geoscene.RasterColormapRenderer; export const RasterColormapRenderer: typeof __geoscene.RasterColormapRenderer; /** * RasterStretchRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/RasterStretchRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterStretchRenderer Read more...} */ export type RasterStretchRenderer = __geoscene.RasterStretchRenderer; export const RasterStretchRenderer: typeof __geoscene.RasterStretchRenderer; /** * VectorFieldRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#VectorFieldRenderer Read more...} */ export type VectorFieldRenderer = __geoscene.VectorFieldRenderer; export const VectorFieldRenderer: typeof __geoscene.VectorFieldRenderer; /** * RasterShadedReliefRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/RasterShadedReliefRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterShadedReliefRenderer Read more...} */ export type RasterShadedReliefRenderer = __geoscene.RasterShadedReliefRenderer; export const RasterShadedReliefRenderer: typeof __geoscene.RasterShadedReliefRenderer; } /** * ClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#ClassBreaksRenderer Read more...} */ export type rasterRenderersClassBreaksRenderer = ClassBreaksRenderer; /** * FlowRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/FlowRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#FlowRenderer Read more...} */ export type rasterRenderersFlowRenderer = FlowRenderer; /** * RasterColormapRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterColormapRenderer Read more...} */ export type rasterRenderersRasterColormapRenderer = RasterColormapRenderer; /** * RasterShadedReliefRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/RasterShadedReliefRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterShadedReliefRenderer Read more...} */ export type rasterRenderersRasterShadedReliefRenderer = RasterShadedReliefRenderer; /** * RasterStretchRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/RasterStretchRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#RasterStretchRenderer Read more...} */ export type rasterRenderersRasterStretchRenderer = RasterStretchRenderer; /** * UniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/UniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#UniqueValueRenderer Read more...} */ export type rasterRenderersUniqueValueRenderer = UniqueValueRenderer; /** * VectorFieldRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rasterRenderers.html#VectorFieldRenderer Read more...} */ export type rasterRenderersVectorFieldRenderer = VectorFieldRenderer; /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} classes when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes} to import union types, or individual modules to import classes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html Read more...} */ namespace renderers { /** * DictionaryRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/DictionaryRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#DictionaryRenderer Read more...} */ export type DictionaryRenderer = __geoscene.DictionaryRenderer; export const DictionaryRenderer: typeof __geoscene.DictionaryRenderer; /** * SimpleRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/SimpleRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#SimpleRenderer Read more...} */ export type SimpleRenderer = __geoscene.SimpleRenderer; export const SimpleRenderer: typeof __geoscene.SimpleRenderer; /** * ClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#ClassBreaksRenderer Read more...} */ export type ClassBreaksRenderer = __geoscene.ClassBreaksRenderer; export const ClassBreaksRenderer: typeof __geoscene.ClassBreaksRenderer; /** * UniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/UniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#UniqueValueRenderer Read more...} */ export type UniqueValueRenderer = __geoscene.UniqueValueRenderer; export const UniqueValueRenderer: typeof __geoscene.UniqueValueRenderer; /** * DotDensityRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/DotDensityRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#DotDensityRenderer Read more...} */ export type DotDensityRenderer = __geoscene.DotDensityRenderer; export const DotDensityRenderer: typeof __geoscene.DotDensityRenderer; /** * PieChartRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PieChartRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#PieChartRenderer Read more...} */ export type PieChartRenderer = __geoscene.PieChartRenderer; export const PieChartRenderer: typeof __geoscene.PieChartRenderer; /** * RendererWithVisualVariables. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~RendererWithVisualVariablesUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#RendererWithVisualVariables Read more...} */ export type RendererWithVisualVariables = | __geoscene.SimpleRenderer | __geoscene.ClassBreaksRenderer | __geoscene.UniqueValueRenderer | __geoscene.DotDensityRenderer | __geoscene.DictionaryRenderer | __geoscene.PieChartRenderer; /** * HeatmapRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/HeatmapRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#HeatmapRenderer Read more...} */ export type HeatmapRenderer = __geoscene.HeatmapRenderer; export const HeatmapRenderer: typeof __geoscene.HeatmapRenderer; /** * Renderer. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~RendererUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#Renderer Read more...} */ export type Renderer = __geoscene.HeatmapRenderer | __geoscene.RendererWithVisualVariables; } export interface ClassBreaksRenderer extends Renderer, VisualVariablesMixin { } export class ClassBreaksRenderer { /** * Label used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} to describe features assigned the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultSymbol default symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultLabel Read more...} */ defaultLabel: string | nullish; /** * The name of a numeric attribute field whose data determines * the symbol of each feature based on the class breaks defined * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfos}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#field Read more...} */ field: string; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType normalizationType} is `field`, this property contains the * attribute field name used for normalization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationField Read more...} */ normalizationField: string | nullish; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType normalizationType} is `percent-of-total`, this property * contains the total of all data values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationTotal Read more...} */ normalizationTotal: number | nullish; /** * Indicates how the data is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType Read more...} */ normalizationType: "field" | "log" | "percent-of-total" | nullish; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#type Read more...} */ readonly type: "class-breaks"; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle: string | nullish; /** * ClassBreaksRenderer defines the symbol of each feature in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} * based on the value of a numeric attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html Read more...} */ constructor(properties?: ClassBreaksRendererProperties); /** * When symbolizing polygon features with graduated symbols, set a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html FillSymbol} * on this property to visualize the boundaries of each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#backgroundFillSymbol Read more...} */ get backgroundFillSymbol(): FillSymbol | PolygonSymbol3D | CIMSymbol | nullish; set backgroundFillSymbol(value: | FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * Each element in the array is an object that provides information about a class break * associated with the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos Read more...} */ get classBreakInfos(): ClassBreakInfo[]; set classBreakInfos(value: ClassBreakInfoProperties[]); /** * The default symbol assigned to features with a value not matched to a given break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultSymbol Read more...} */ get defaultSymbol(): SymbolUnion | nullish; set defaultSymbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#legendOptions Read more...} */ get legendOptions(): ClassBreaksRendererLegendOptions | nullish; set legendOptions(value: ClassBreaksRendererLegendOptionsProperties | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Adds a class break to the renderer. * * @param min The minimum value to use in the break. This can be a number or an info object as defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfos}. * @param max The maximum value to use in the break. * @param symbol Symbol to use for the break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#addClassBreakInfo Read more...} */ addClassBreakInfo(min: number | any, max?: number, symbol?: SymbolUnion): void; /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#clone Read more...} */ clone(): ClassBreaksRenderer; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfo} information (as defined by the renderer) * associated with the given graphic. * * @param graphic The graphic whose rendering information will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#getClassBreakInfo Read more...} */ getClassBreakInfo(graphic: Graphic): Promise; /** * Removes a break from the renderer. * * @param min Minimum value in the break to remove * @param max Maximum value in the break to remove. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#removeClassBreakInfo Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html FillSymbol} * on this property to visualize the boundaries of each feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#backgroundFillSymbol Read more...} */ backgroundFillSymbol?: | FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * Each element in the array is an object that provides information about a class break * associated with the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos Read more...} */ classBreakInfos?: ClassBreakInfoProperties[]; /** * Label used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} to describe features assigned the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultSymbol default symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultLabel Read more...} */ defaultLabel?: string | nullish; /** * The default symbol assigned to features with a value not matched to a given break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#defaultSymbol Read more...} */ defaultSymbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * The name of a numeric attribute field whose data determines * the symbol of each feature based on the class breaks defined * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfos}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#field Read more...} */ field?: string; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#legendOptions Read more...} */ legendOptions?: ClassBreaksRendererLegendOptionsProperties | nullish; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType normalizationType} is `field`, this property contains the * attribute field name used for normalization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationField Read more...} */ normalizationField?: string | nullish; /** * When {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType normalizationType} is `percent-of-total`, this property * contains the total of all data values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationTotal Read more...} */ normalizationTotal?: number | nullish; /** * Indicates how the data is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#normalizationType Read more...} */ normalizationType?: "field" | "log" | "percent-of-total" | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpression Read more...} */ valueExpression?: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface ClassBreaksRendererLegendOptionsProperties { title?: string | nullish; } export interface ClassBreaksRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#config Read more...} */ config: any | nullish; /** * Defines a field mapping that maps input fields from the feature to the dictionary symbol style's expected fields for symbols and * text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#fieldMap Read more...} */ fieldMap: HashMap | nullish; /** * A scaling expression can be set to increase or decrease the size of the dictionary symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpression Read more...} */ scaleExpression: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpression scaleExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpressionTitle Read more...} */ scaleExpressionTitle: string | nullish; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#type Read more...} */ type: "dictionary"; /** * The URL to the dictionary style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#url Read more...} */ url: string | nullish; /** * Dictionary Renderer is used to symbolize layers using a dictionary of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbols} configured with multiple * attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html Read more...} */ constructor(properties?: DictionaryRendererProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#clone Read more...} */ clone(): DictionaryRenderer; /** * This method will return the symbol for a given graphic using the dictionary renderer. * * @param graphic The graphic used to get the resulting symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#getSymbolAsync Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#config Read more...} */ config?: any | nullish; /** * Defines a field mapping that maps input fields from the feature to the dictionary symbol style's expected fields for symbols and * text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#fieldMap Read more...} */ fieldMap?: HashMap | nullish; /** * A scaling expression can be set to increase or decrease the size of the dictionary symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpression Read more...} */ scaleExpression?: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpression scaleExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#scaleExpressionTitle Read more...} */ scaleExpressionTitle?: string | nullish; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#type Read more...} */ type?: "dictionary"; /** * The URL to the dictionary style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#url Read more...} */ url?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DictionaryRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export class DotDensityRenderer extends Renderer { /** * Only applicable when two or more {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#attributes attributes} are specified. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotBlendingEnabled Read more...} */ dotBlendingEnabled: boolean; /** * Defines the size of the dots in points. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotSize Read more...} */ dotSize: number; /** * Defines the initial dot value used for visualizing density. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotValue Read more...} */ dotValue: number; /** * When defined, the renderer will recalculate the dot value linearly based on the change in the view's scale * using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#calculateDotValue calculateDotValue()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#referenceScale Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#seed Read more...} */ seed: number; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#type Read more...} */ readonly type: "dot-density"; /** * DotDensityRenderer allows you to create dot density visualizations for polygon layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html Read more...} */ constructor(properties?: DotDensityRendererProperties); /** * Defines the variable(s) used to visualize density. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#attributes Read more...} */ get attributes(): AttributeColorInfo[]; set attributes(value: AttributeColorInfoProperties[]); /** * The color used to shade the polygon fill behind the dots. * * @default [0, 0, 0, 0.25] - black, semitransparent * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#backgroundColor Read more...} */ get backgroundColor(): Color; set backgroundColor(value: ColorProperties); /** * An object providing options for configuring the renderer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#legendOptions Read more...} */ get legendOptions(): DotDensityRendererLegendOptions | nullish; set legendOptions(value: DotDensityRendererLegendOptionsProperties | nullish); /** * The outline of the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#outline Read more...} */ get outline(): SimpleLineSymbol; set outline(value: SimpleLineSymbolProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html Size Visual Variable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Calculates an updated dot value for the given scale for the cases where a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#referenceScale referenceScale} * is provided. * * @param scale The view scale at which to calculate a new dot value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#calculateDotValue Read more...} */ calculateDotValue(scale: number): number; /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#clone Read more...} */ clone(): DotDensityRenderer; static fromJSON(json: any): DotDensityRenderer; } interface DotDensityRendererProperties extends RendererProperties { /** * Defines the variable(s) used to visualize density. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#attributes Read more...} */ attributes?: AttributeColorInfoProperties[]; /** * The color used to shade the polygon fill behind the dots. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#backgroundColor Read more...} */ backgroundColor?: ColorProperties; /** * Only applicable when two or more {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#attributes attributes} are specified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotBlendingEnabled Read more...} */ dotBlendingEnabled?: boolean; /** * Defines the size of the dots in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotSize Read more...} */ dotSize?: number; /** * Defines the initial dot value used for visualizing density. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#dotValue Read more...} */ dotValue?: number; /** * An object providing options for configuring the renderer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#legendOptions Read more...} */ legendOptions?: DotDensityRendererLegendOptionsProperties | nullish; /** * The outline of the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#outline Read more...} */ outline?: SimpleLineSymbolProperties; /** * When defined, the renderer will recalculate the dot value linearly based on the change in the view's scale * using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#calculateDotValue calculateDotValue()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#referenceScale Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#seed Read more...} */ seed?: number; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html Size Visual Variable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface DotDensityRendererLegendOptionsProperties { unit?: string | nullish; } export interface DotDensityRendererLegendOptions extends AnonymousAccessor { unit: string | nullish; } export interface FlowRenderer extends Accessor, JSONSupport { } export class FlowRenderer { /** * The density of the streamlines. * * @default 0.8 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#density Read more...} */ density: number; /** * Defines the flow direction of the data. * * @default "flow-from" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#flowRepresentation Read more...} */ flowRepresentation: "flow-from" | "flow-to"; /** * The speed of the animated streamlines, relative to the simulation time. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#flowSpeed Read more...} */ flowSpeed: number; /** * The front cap of the streamline. * * @default "butt" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailCap Read more...} */ trailCap: "butt" | "round"; /** * The approximate visible length of the streamline in points. * * @default 100 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailLength Read more...} */ trailLength: number; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#type Read more...} */ readonly type: "flow"; /** * The FlowRenderer allows you to visualize your raster data with animated streamlines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html Read more...} */ constructor(properties?: FlowRendererProperties); /** * Contains metadata about renderers generated from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html#createRenderer flowRendererCreator.createRenderer()} method, * including information for setting UI elements such as sliders and themes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#authoringInfo Read more...} */ get authoringInfo(): AuthoringInfo; set authoringInfo(value: AuthoringInfoProperties); /** * The color of the animated streamlines. * * @default [255, 255, 255, 1] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#legendOptions Read more...} */ get legendOptions(): FlowRendererLegendOptions | nullish; set legendOptions(value: FlowRendererLegendOptionsProperties | nullish); /** * The maximum path length streamlines will travel in points. * * @default 200 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#maxPathLength Read more...} */ get maxPathLength(): number; set maxPathLength(value: number | string); /** * The width of the streamline trail in points. * * @default 1.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailWidth Read more...} */ get trailWidth(): number; set trailWidth(value: number | string); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#clone Read more...} */ clone(): FlowRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FlowRenderer; } interface FlowRendererProperties { /** * Contains metadata about renderers generated from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html#createRenderer flowRendererCreator.createRenderer()} method, * including information for setting UI elements such as sliders and themes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#authoringInfo Read more...} */ authoringInfo?: AuthoringInfoProperties; /** * The color of the animated streamlines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#color Read more...} */ color?: ColorProperties; /** * The density of the streamlines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#density Read more...} */ density?: number; /** * Defines the flow direction of the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#flowRepresentation Read more...} */ flowRepresentation?: "flow-from" | "flow-to"; /** * The speed of the animated streamlines, relative to the simulation time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#flowSpeed Read more...} */ flowSpeed?: number; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#legendOptions Read more...} */ legendOptions?: FlowRendererLegendOptionsProperties | nullish; /** * The maximum path length streamlines will travel in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#maxPathLength Read more...} */ maxPathLength?: number | string; /** * The front cap of the streamline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailCap Read more...} */ trailCap?: "butt" | "round"; /** * The approximate visible length of the streamline in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailLength Read more...} */ trailLength?: number; /** * The width of the streamline trail in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#trailWidth Read more...} */ trailWidth?: number | string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface FlowRendererLegendOptionsProperties { title?: string | nullish; } export interface FlowRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export class HeatmapRenderer extends Renderer { /** * The name of the attribute field used to weight the density of each heatmap point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#field Read more...} */ field: string; /** * The max density value to be assigned a color in the heatmap surface. * * @default 0.04 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#maxDensity Read more...} */ maxDensity: number; /** * The minimum density value to be assigned a color in the heatmap surface. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#minDensity Read more...} */ minDensity: 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#referenceScale Read more...} */ referenceScale: number; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#type Read more...} */ readonly type: "heatmap"; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * The title identifying and describing the {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle: string | nullish; /** * The HeatmapRenderer uses [kernel density](https://pro.geoscene.cn/zh/pro-app/2.8/tool-reference/spatial-analyst/how-kernel-density-works.htm) * to render point features in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayers}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayers} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html OGCFeatureLayers} as a raster surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html Read more...} */ constructor(properties?: HeatmapRendererProperties); /** * An array of objects describing the renderer's color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#colorStops Read more...} */ get colorStops(): HeatmapColorStop[]; set colorStops(value: HeatmapColorStopProperties[]); /** * An object providing options for describing the renderer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#legendOptions Read more...} */ get legendOptions(): HeatmapRendererLegendOptions | nullish; set legendOptions(value: HeatmapRendererLegendOptionsProperties | nullish); /** * The search radius (in points) used to create a smooth kernel surface fitted around each point. * * @default 18 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#radius Read more...} */ get radius(): number; set radius(value: number | string); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#clone Read more...} */ clone(): HeatmapRenderer; static fromJSON(json: any): HeatmapRenderer; } interface HeatmapRendererProperties extends RendererProperties { /** * An array of objects describing the renderer's color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#colorStops Read more...} */ colorStops?: HeatmapColorStopProperties[]; /** * The name of the attribute field used to weight the density of each heatmap point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#field Read more...} */ field?: string; /** * An object providing options for describing the renderer in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#legendOptions Read more...} */ legendOptions?: HeatmapRendererLegendOptionsProperties | nullish; /** * The max density value to be assigned a color in the heatmap surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#maxDensity Read more...} */ maxDensity?: number; /** * The minimum density value to be assigned a color in the heatmap surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#minDensity Read more...} */ minDensity?: number; /** * The search radius (in points) used to create a smooth kernel surface fitted around each point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#radius Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#referenceScale Read more...} */ referenceScale?: number; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpression Read more...} */ valueExpression?: string | nullish; /** * The title identifying and describing the {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle?: string | nullish; } export interface HeatmapRendererLegendOptionsProperties { minLabel?: string | nullish; maxLabel?: string | nullish; title?: string | nullish; } export interface HeatmapRendererLegendOptions extends AnonymousAccessor { minLabel: string | nullish; maxLabel: string | nullish; title: string | nullish; } export class VisualVariablesMixin { get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); } interface VisualVariablesMixinProperties { visualVariables?: VisualVariableProperties[] | nullish; } export class PieChartRenderer extends Renderer { /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultColor defaultColor} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultLabel Read more...} */ defaultLabel: string | nullish; /** * Use this property to create a donut chart. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#holePercentage Read more...} */ holePercentage: number; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#type Read more...} */ readonly type: "pie-chart"; /** * PieChartRenderer allows you to create a pie chart for each feature in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html Read more...} */ constructor(properties?: PieChartRendererProperties); /** * Defines the variable(s) to include in the pie charts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#attributes Read more...} */ get attributes(): AttributeColorInfo[]; set attributes(value: AttributeColorInfoProperties[]); /** * The symbol used to render polygons behind the pie symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#backgroundFillSymbol Read more...} */ get backgroundFillSymbol(): SimpleFillSymbol | CIMSymbol | nullish; set backgroundFillSymbol(value: (SimpleFillSymbolProperties & { type: "simple-fill" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The color used to visualize features whose {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#attributes attributes} all have null or empty values. * * @default new Color([0, 0, 0, 0]) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultColor Read more...} */ get defaultColor(): Color; set defaultColor(value: ColorProperties); /** * An object providing options for describing the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#legendOptions Read more...} */ get legendOptions(): PieChartRendererLegendOptions | nullish; set legendOptions(value: PieChartRendererLegendOptionsProperties | nullish); /** * Defines the rules for how to aggregate small categories to a generic "others" category. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#othersCategory Read more...} */ get othersCategory(): PieChartRendererOthersCategory | nullish; set othersCategory(value: PieChartRendererOthersCategoryProperties | nullish); /** * Defines the outline of the pie chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#outline Read more...} */ get outline(): SimpleLineSymbol | nullish; set outline(value: SimpleLineSymbolProperties | nullish); /** * Defines the size of each pie chart in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#size Read more...} */ get size(): number; set size(value: number | string); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html Size Visual Variable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#visualVariables Read more...} */ get visualVariables(): (SizeVariable | OpacityVariable)[] | nullish; set visualVariables(value: | ((SizeVariableProperties & { type: "size" }) | (OpacityVariableProperties & { type: "opacity" }))[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#clone Read more...} */ clone(): PieChartRenderer; static fromJSON(json: any): PieChartRenderer; } interface PieChartRendererProperties extends RendererProperties { /** * Defines the variable(s) to include in the pie charts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#attributes Read more...} */ attributes?: AttributeColorInfoProperties[]; /** * The symbol used to render polygons behind the pie symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#backgroundFillSymbol Read more...} */ backgroundFillSymbol?: | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The color used to visualize features whose {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#attributes attributes} all have null or empty values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultColor Read more...} */ defaultColor?: ColorProperties; /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultColor defaultColor} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#defaultLabel Read more...} */ defaultLabel?: string | nullish; /** * Use this property to create a donut chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#holePercentage Read more...} */ holePercentage?: number; /** * An object providing options for describing the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#legendOptions Read more...} */ legendOptions?: PieChartRendererLegendOptionsProperties | nullish; /** * Defines the rules for how to aggregate small categories to a generic "others" category. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#othersCategory Read more...} */ othersCategory?: PieChartRendererOthersCategoryProperties | nullish; /** * Defines the outline of the pie chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#outline Read more...} */ outline?: SimpleLineSymbolProperties | nullish; /** * Defines the size of each pie chart in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#size Read more...} */ size?: number | string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html Size Visual Variable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#visualVariables Read more...} */ visualVariables?: | ((SizeVariableProperties & { type: "size" }) | (OpacityVariableProperties & { type: "opacity" }))[] | nullish; } export interface PieChartRendererLegendOptionsProperties { title?: string | nullish; } export interface PieChartRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export interface PieChartRendererOthersCategoryProperties { color?: ColorProperties | string | number[]; label?: string | nullish; threshold?: number; } export interface PieChartRendererOthersCategory extends AnonymousAccessor { get color(): Color; set color(value: ColorProperties | string | number[]); label: string | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos Read more...} */ colorClassBreakInfos: PointCloudClassBreaksRendererColorClassBreakInfos[] | nullish; /** * The name of the field that is used to drive the color visualization for the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#field Read more...} */ field: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType Read more...} */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#type Read more...} */ readonly type: "point-cloud-class-breaks"; /** * This class defines the color of each point in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} * based on the value of a numeric attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html Read more...} */ constructor(properties?: PointCloudClassBreaksRendererProperties); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#legendOptions Read more...} */ get legendOptions(): PointCloudClassBreaksRendererLegendOptions | nullish; set legendOptions(value: PointCloudClassBreaksRendererLegendOptionsProperties | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#colorClassBreakInfos Read more...} */ colorClassBreakInfos?: PointCloudClassBreaksRendererColorClassBreakInfos[] | nullish; /** * The name of the field that is used to drive the color visualization for the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#field Read more...} */ field?: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#fieldTransformType Read more...} */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudClassBreaksRenderer.html#legendOptions Read more...} */ legendOptions?: PointCloudClassBreaksRendererLegendOptionsProperties | nullish; } export interface PointCloudClassBreaksRendererColorClassBreakInfos { minValue: number; maxValue: number; color: Color; label?: string | nullish; } export interface PointCloudClassBreaksRendererLegendOptionsProperties { title?: string | nullish; } export interface PointCloudClassBreaksRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export interface PointCloudRenderer extends Accessor, JSONSupport { } export class PointCloudRenderer { /** * The number of points to draw per display inch. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#pointsPerInch Read more...} */ pointsPerInch: number; /** * The point cloud renderer type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#type Read more...} */ 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} are rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html Read more...} */ constructor(properties?: PointCloudRendererProperties); /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#colorModulation Read more...} */ get colorModulation(): PointCloudRendererColorModulation; set colorModulation(value: PointCloudRendererColorModulationProperties); /** * Specifies how the size of the points in the point cloud is computed for * rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#pointSizeAlgorithm Read more...} */ get pointSizeAlgorithm(): PointSizeFixedSizeAlgorithm | PointSizeSplatAlgorithm; set pointSizeAlgorithm(value: | (PointSizeFixedSizeAlgorithmProperties & { type: "fixed-size" }) | (PointSizeSplatAlgorithmProperties & { type: "splat" })); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#clone Read more...} */ clone(): PointCloudRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PointCloudRenderer; } interface PointCloudRendererProperties { /** * Reduces the brightness of the point's color, based on the value of another field, usually `intensity`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#colorModulation Read more...} */ colorModulation?: PointCloudRendererColorModulationProperties; /** * Specifies how the size of the points in the point cloud is computed for * rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#pointSizeAlgorithm Read more...} */ pointSizeAlgorithm?: | (PointSizeFixedSizeAlgorithmProperties & { type: "fixed-size" }) | (PointSizeSplatAlgorithmProperties & { type: "splat" }); /** * The number of points to draw per display inch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRenderer.html#pointsPerInch Read more...} */ pointsPerInch?: number; } export interface PointCloudRendererColorModulationProperties { field?: string; minValue?: number; maxValue?: number; } export interface PointCloudRendererColorModulation extends AnonymousAccessor { field: string; minValue: number; maxValue: number; } export interface PointSizeFixedSizeAlgorithmProperties { type?: "fixed-size"; useRealWorldSymbolSizes?: boolean | nullish; size?: number; } export interface PointSizeFixedSizeAlgorithm extends AnonymousAccessor { type: "fixed-size"; useRealWorldSymbolSizes: boolean | nullish; size: number; } export interface PointSizeSplatAlgorithmProperties { type?: "splat"; scaleFactor?: number; } export interface PointSizeSplatAlgorithm extends AnonymousAccessor { type: "splat"; scaleFactor: number; } export class PointCloudRGBRenderer extends PointCloudRenderer { /** * The name of the field containing RGB values used to drive the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html#field Read more...} */ field: string | nullish; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html#type Read more...} */ readonly type: "point-cloud-rgb"; /** * PointCloudRGBRenderer defines the color of each point in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} * based on the value of a color attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html Read more...} */ constructor(properties?: PointCloudRGBRendererProperties); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html#clone Read more...} */ clone(): PointCloudRGBRenderer; static fromJSON(json: any): PointCloudRGBRenderer; } interface PointCloudRGBRendererProperties extends PointCloudRendererProperties { /** * The name of the field containing RGB values used to drive the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html#field Read more...} */ field?: string | nullish; } export class PointCloudStretchRenderer extends PointCloudRenderer { /** * The name of the number field whose values are used to drive the continuous color visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#field Read more...} */ field: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#fieldTransformType Read more...} */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#type Read more...} */ readonly type: "point-cloud-stretch"; /** * PointCloudStretchRenderer defines the color of each point in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} * based on the value of a numeric attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html Read more...} */ constructor(properties?: PointCloudStretchRendererProperties); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#legendOptions Read more...} */ get legendOptions(): PointCloudStretchRendererLegendOptions | nullish; set legendOptions(value: PointCloudStretchRendererLegendOptionsProperties | nullish); /** * An array of color value pairs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#stops Read more...} */ get stops(): ColorStop[] | nullish; set stops(value: ColorStopProperties[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#field Read more...} */ field?: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#fieldTransformType Read more...} */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#legendOptions Read more...} */ legendOptions?: PointCloudStretchRendererLegendOptionsProperties | nullish; /** * An array of color value pairs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html#stops Read more...} */ stops?: ColorStopProperties[] | nullish; } export interface PointCloudStretchRendererLegendOptionsProperties { title?: string | nullish; } export interface PointCloudStretchRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export class PointCloudUniqueValueRenderer extends PointCloudRenderer { /** * Each element in the array is an object that matches a unique value * with a specific color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos Read more...} */ colorUniqueValueInfos: PointCloudUniqueValueRendererColorUniqueValueInfos[] | nullish; /** * The name of the field whose values are used to drive the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#field Read more...} */ field: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType Read more...} */ fieldTransformType: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#type Read more...} */ readonly type: "point-cloud-unique-value"; /** * PointCloudUniqueValueRenderer allows you to colorize points in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} based on an attribute value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html Read more...} */ constructor(properties?: PointCloudUniqueValueRendererProperties); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#legendOptions Read more...} */ get legendOptions(): PointCloudUniqueValueRendererLegendOptions | nullish; set legendOptions(value: PointCloudUniqueValueRendererLegendOptionsProperties | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#colorUniqueValueInfos Read more...} */ colorUniqueValueInfos?: PointCloudUniqueValueRendererColorUniqueValueInfos[] | nullish; /** * The name of the field whose values are used to drive the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#field Read more...} */ field?: string | nullish; /** * A transform that is applied to the field value before evaluating the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#fieldTransformType Read more...} */ fieldTransformType?: "none" | "low-four-bit" | "high-four-bit" | "absolute-value" | "modulo-ten" | nullish; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html#legendOptions Read more...} */ legendOptions?: PointCloudUniqueValueRendererLegendOptionsProperties | nullish; } export interface PointCloudUniqueValueRendererColorUniqueValueInfos { values: string[]; color: Color; label?: string | nullish; } export interface PointCloudUniqueValueRendererLegendOptionsProperties { title?: string | nullish; } export interface PointCloudUniqueValueRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export interface RasterColormapRenderer extends Accessor, JSONSupport { } export class RasterColormapRenderer { /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#type Read more...} */ readonly type: "raster-colormap"; /** * The RasterColormapRenderer defines the symbology to display raster data based on specific colors, * aiding in visual analysis of the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html Read more...} */ constructor(properties?: RasterColormapRendererProperties); /** * A colormap info array containing mappings for pixel and RGB color values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#colormapInfos Read more...} */ get colormapInfos(): ColormapInfo[]; set colormapInfos(value: ColormapInfoProperties[]); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#clone Read more...} */ clone(): RasterColormapRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html RasterColormapRenderer} from an array of color maps * where pixel values with its corresponding RGB color values specified. * * @param colormap RGB color representation of pixel values. Each item in the colormap array has an array of the pixel value and red, green, and blue values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#createFromColormap Read more...} */ static createFromColormap(colormap: number[][] | nullish): RasterColormapRenderer | nullish; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterColormapRenderer; } interface RasterColormapRendererProperties { /** * A colormap info array containing mappings for pixel and RGB color values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html#colormapInfos Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#altitude Read more...} */ altitude: number; /** * The sun's relative position along the horizon, ranging from 0 to 360 degrees. * * @default 315 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#azimuth Read more...} */ azimuth: number; /** * The type of hillshading being applied on the elevation surface. * * @default "traditional" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#hillshadeType Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#pixelSizeFactor Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#pixelSizePower Read more...} */ pixelSizePower: number; /** * Applies a constant or adjusted z-factor based on resolution changes. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#scalingType Read more...} */ scalingType: "none" | "adjusted"; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#type Read more...} */ readonly type: "raster-shaded-relief"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#zFactor Read more...} */ zFactor: number; /** * RasterShadedReliefRenderer produces a grayscale or colored 3D representation of the surface on an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}, with the sun's relative position taken into account * for shading the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html Read more...} */ constructor(properties?: RasterShadedReliefRendererProperties); /** * The color ramp to display the shaded relief. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#colorRamp Read more...} */ get colorRamp(): ColorRamp | nullish; set colorRamp(value: ColorRampProperties | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#clone Read more...} */ clone(): RasterShadedReliefRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterShadedReliefRenderer; } interface RasterShadedReliefRendererProperties { /** * The sun's angle of elevation above the horizon, ranging from 0 to 90 degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#altitude Read more...} */ altitude?: number; /** * The sun's relative position along the horizon, ranging from 0 to 360 degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#azimuth Read more...} */ azimuth?: number; /** * The color ramp to display the shaded relief. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#colorRamp Read more...} */ colorRamp?: ColorRampProperties | nullish; /** * The type of hillshading being applied on the elevation surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#hillshadeType Read more...} */ hillshadeType?: "traditional" | "multi-directional"; /** * Pixel size factor accounts for changes in scale as the viewer zooms in and out on the map display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#pixelSizeFactor Read more...} */ pixelSizeFactor?: number; /** * Pixel Size Power accounts for the altitude changes (or scale) as the viewer zooms in and out on the map display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#pixelSizePower Read more...} */ pixelSizePower?: number; /** * Applies a constant or adjusted z-factor based on resolution changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#scalingType Read more...} */ scalingType?: "none" | "adjusted"; /** * A ratio of z unit / xy unit, with optional exaggeration factored in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html#zFactor Read more...} */ zFactor?: number; } export interface RasterStretchRenderer extends Accessor, JSONSupport { } export class RasterStretchRenderer { /** * The computeGamma automatically calculates best gamma value to render exported image based on empirical model. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#computeGamma Read more...} */ computeGamma: boolean; /** * The input band statistics can be specified through the customStatistics property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#customStatistics Read more...} */ customStatistics: RasterBandStatistics[] | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment Read more...} */ dynamicRangeAdjustment: boolean; /** * The gamma values to be used if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#useGamma useGamma} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#gamma Read more...} */ gamma: number[]; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `percent-clip`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#maxPercent Read more...} */ maxPercent: number | nullish; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `percent-clip`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#minPercent Read more...} */ minPercent: number | nullish; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `standard-deviation`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#numberOfStandardDeviations Read more...} */ numberOfStandardDeviations: number | nullish; /** * The outputMax denotes the output maximum, which is the highest pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#outputMax Read more...} */ outputMax: number | nullish; /** * The outputMin denotes the output minimum, which is the lowest pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#outputMin Read more...} */ outputMin: number | nullish; /** * The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#sigmoidStrengthLevel Read more...} */ sigmoidStrengthLevel: number | nullish; /** * The input statistics can be specified through the statistics property. * * @deprecated since version 4.31. Use {@link module:geoscene/renderers/RasterStretchRenderer#customStatistics customStatistics} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#statistics Read more...} */ statistics: number[][] | RasterBandStatistics[] | nullish; /** * The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType Read more...} */ stretchType: "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid"; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#type Read more...} */ readonly type: "raster-stretch"; /** * Denotes whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#gamma gamma} value should be used. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#useGamma Read more...} */ useGamma: boolean; /** * RasterStretchRenderer defines the symbology with a gradual ramp of colors for each pixel in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WCSLayer.html WCSLayer} based on the pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html Read more...} */ constructor(properties?: RasterStretchRendererProperties); /** * The stretched values are mapped to this specified color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#colorRamp Read more...} */ get colorRamp(): ColorRamp | nullish; set colorRamp(value: ColorRampProperties | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#clone Read more...} */ clone(): RasterStretchRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterStretchRenderer; } interface RasterStretchRendererProperties { /** * The stretched values are mapped to this specified color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#colorRamp Read more...} */ colorRamp?: ColorRampProperties | nullish; /** * The computeGamma automatically calculates best gamma value to render exported image based on empirical model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#computeGamma Read more...} */ computeGamma?: boolean; /** * The input band statistics can be specified through the customStatistics property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#customStatistics Read more...} */ customStatistics?: RasterBandStatistics[] | nullish; /** * When Dynamic Range Adjustment is `true`, the statistics based on the current display extent * are calculated as you zoom and pan around the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment Read more...} */ dynamicRangeAdjustment?: boolean; /** * The gamma values to be used if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#useGamma useGamma} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#gamma Read more...} */ gamma?: number[]; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `percent-clip`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#maxPercent Read more...} */ maxPercent?: number | nullish; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `percent-clip`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#minPercent Read more...} */ minPercent?: number | nullish; /** * Applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType stretchType} is `standard-deviation`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#numberOfStandardDeviations Read more...} */ numberOfStandardDeviations?: number | nullish; /** * The outputMax denotes the output maximum, which is the highest pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#outputMax Read more...} */ outputMax?: number | nullish; /** * The outputMin denotes the output minimum, which is the lowest pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#outputMin Read more...} */ outputMin?: number | nullish; /** * The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#sigmoidStrengthLevel Read more...} */ sigmoidStrengthLevel?: number | nullish; /** * The input statistics can be specified through the statistics property. * * @deprecated since version 4.31. Use {@link module:geoscene/renderers/RasterStretchRenderer#customStatistics customStatistics} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#statistics Read more...} */ statistics?: number[][] | RasterBandStatistics[] | nullish; /** * The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#stretchType Read more...} */ stretchType?: "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid"; /** * Denotes whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#gamma gamma} value should be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html#useGamma Read more...} */ useGamma?: boolean; } export interface Renderer extends Accessor, JSONSupport { } export class Renderer { /** * The renderer type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html#type Read more...} */ 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:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Read more...} */ constructor(properties?: RendererProperties); /** * Authoring metadata only included in renderers generated from one of the * Smart Mapping creator methods, such as * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer sizeRendererCreator.createContinuousRenderer()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer colorRendererCreator.createContinuousRenderer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html#authoringInfo Read more...} */ get authoringInfo(): AuthoringInfo | nullish; set authoringInfo(value: AuthoringInfoProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Renderer; } interface RendererProperties { /** * Authoring metadata only included in renderers generated from one of the * Smart Mapping creator methods, such as * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer sizeRendererCreator.createContinuousRenderer()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer colorRendererCreator.createContinuousRenderer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html#authoringInfo Read more...} */ authoringInfo?: AuthoringInfoProperties | nullish; } export interface SimpleRenderer extends Renderer, VisualVariablesMixin { } export class SimpleRenderer { /** * The label for the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#label Read more...} */ label: string | nullish; /** * The type of renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#type Read more...} */ readonly type: "simple"; /** * SimpleRenderer renders all features in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} with one * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html Read more...} */ constructor(properties?: SimpleRendererProperties); /** * The symbol used by the renderer to visualize all features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#symbol Read more...} */ get symbol(): SymbolUnion | nullish; set symbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#clone Read more...} */ clone(): SimpleRenderer; static fromJSON(json: any): SimpleRenderer; } interface SimpleRendererProperties extends RendererProperties, VisualVariablesMixinProperties { /** * The label for the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#label Read more...} */ label?: string | nullish; /** * The symbol used by the renderer to visualize all features in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#symbol Read more...} */ symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface AttributeColorInfo extends Accessor, JSONSupport { } export class AttributeColorInfo { /** * The name of the numeric attribute field represented by the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#field Read more...} */ field: string | nullish; /** * The label used to describe the field or attribute in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#label Read more...} */ label: string | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * The title identifying and describing the associated * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpressionTitle Read more...} */ valueExpressionTitle: string | nullish; /** * Defines colors for dots in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html#attributes DotDensityRenderer}, * or colors for pie chart slices in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html#attributes PieChartRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html Read more...} */ constructor(properties?: AttributeColorInfoProperties); /** * The color used to render dots representing the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#field field} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html DotDensityRenderer} or * the color used to represent a pie chart slice in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html PieChartRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#clone Read more...} */ clone(): AttributeColorInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeColorInfo; } interface AttributeColorInfoProperties { /** * The color used to render dots representing the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#field field} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html DotDensityRenderer} or * the color used to represent a pie chart slice in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html PieChartRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#color Read more...} */ color?: ColorProperties | nullish; /** * The name of the numeric attribute field represented by the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#field Read more...} */ field?: string | nullish; /** * The label used to describe the field or attribute in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#label Read more...} */ label?: string | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpression Read more...} */ valueExpression?: string | nullish; /** * The title identifying and describing the associated * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AttributeColorInfo.html#valueExpressionTitle Read more...} */ valueExpressionTitle?: string | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#classificationMethod Read more...} */ classificationMethod: | "equal-interval" | "defined-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation" | nullish; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} * created with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html heatmap renderer creator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#fadeRatio Read more...} */ fadeRatio: number | nullish; /** * An array of string values representing field names used for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html predominance renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#fields Read more...} */ fields: string[] | nullish; /** * Only applicable to flow renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#flowTheme Read more...} */ flowTheme: "flow-line" | "wave-front" | nullish; /** * The focus of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#focus Read more...} */ focus: string | nullish; /** * Indicates whether the renderer was created internally by the JS API's rendering engine for * default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualizations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#isAutoGenerated Read more...} */ isAutoGenerated: boolean; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#lengthUnit Read more...} */ lengthUnit: | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | nullish; /** * Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#maxSliderValue Read more...} */ maxSliderValue: number | nullish; /** * Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#minSliderValue Read more...} */ minSliderValue: number | nullish; /** * The number of classes used to classify each field of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#numClasses Read more...} */ numClasses: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#standardDeviationInterval Read more...} */ standardDeviationInterval: number | nullish; /** * Only for renderers of type `univariate-color-size` with an `above-and-below` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme univariateTheme}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#statistics Read more...} */ statistics: AuthoringInfoStatistics | nullish; /** * Indicates the renderer type generated from one of the Smart Mapping functions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#type Read more...} */ type: | "class-breaks-size" | "class-breaks-color" | "classed-color" | "classed-size" | "dot-density" | "flow" | "predominance" | "relationship" | "univariate-color-size"; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html univariateColorSize} renderers with an `above-and-below` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme univariateTheme}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateSymbolStyle Read more...} */ univariateSymbolStyle: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb" | "custom" | nullish; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html univariateColorSize} renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme Read more...} */ univariateTheme: "high-to-low" | "above" | "below" | "above-and-below" | nullish; /** * Authoring information related to generating renderers * and visual variables with the Smart Mapping methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html Read more...} */ constructor(properties?: AuthoringInfoProperties); /** * Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#colorRamp Read more...} */ get colorRamp(): ColorRamp | nullish; set colorRamp(value: ColorRampProperties | nullish); /** * A numeric field used for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer} * along with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field2 field2}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field1 Read more...} */ get field1(): AuthoringInfoField1 | nullish; set field1(value: AuthoringInfoField1Properties | nullish); /** * A numeric field used for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer} * along with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field1 field1}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field2 Read more...} */ get field2(): AuthoringInfoField2 | nullish; set field2(value: AuthoringInfoField2Properties | nullish); /** * Contains authoring properties of visual variables generated from * one of the Smart Mapping methods or sliders. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#visualVariables Read more...} */ get visualVariables(): AuthoringInfoVisualVariable[]; set visualVariables(value: AuthoringInfoVisualVariableProperties[]); /** * Creates a deep clone of the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#clone Read more...} */ clone(): AuthoringInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#classificationMethod Read more...} */ classificationMethod?: | "equal-interval" | "defined-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation" | nullish; /** * Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#colorRamp Read more...} */ colorRamp?: ColorRampProperties | nullish; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} * created with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html heatmap renderer creator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#fadeRatio Read more...} */ fadeRatio?: number | nullish; /** * A numeric field used for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer} * along with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field2 field2}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field1 Read more...} */ field1?: AuthoringInfoField1Properties | nullish; /** * A numeric field used for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer} * along with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field1 field1}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#field2 Read more...} */ field2?: AuthoringInfoField2Properties | nullish; /** * An array of string values representing field names used for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html predominance renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#fields Read more...} */ fields?: string[] | nullish; /** * Only applicable to flow renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#flowTheme Read more...} */ flowTheme?: "flow-line" | "wave-front" | nullish; /** * The focus of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#focus Read more...} */ focus?: string | nullish; /** * Indicates whether the renderer was created internally by the JS API's rendering engine for * default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#isAutoGenerated Read more...} */ isAutoGenerated?: boolean; /** * **Only applicable to renderer used in web scenes.** Indicates the unit used in real-world sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#lengthUnit Read more...} */ lengthUnit?: | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | nullish; /** * Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#maxSliderValue Read more...} */ maxSliderValue?: number | nullish; /** * Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#minSliderValue Read more...} */ minSliderValue?: number | nullish; /** * The number of classes used to classify each field of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#numClasses Read more...} */ numClasses?: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#standardDeviationInterval Read more...} */ standardDeviationInterval?: number | nullish; /** * Only for renderers of type `univariate-color-size` with an `above-and-below` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme univariateTheme}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#statistics Read more...} */ statistics?: AuthoringInfoStatistics | nullish; /** * Indicates the renderer type generated from one of the Smart Mapping functions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#type Read more...} */ type?: | "class-breaks-size" | "class-breaks-color" | "classed-color" | "classed-size" | "dot-density" | "flow" | "predominance" | "relationship" | "univariate-color-size"; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html univariateColorSize} renderers with an `above-and-below` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme univariateTheme}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateSymbolStyle Read more...} */ univariateSymbolStyle?: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb" | "custom" | nullish; /** * Only applicable to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html univariateColorSize} renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#univariateTheme Read more...} */ univariateTheme?: "high-to-low" | "above" | "below" | "above-and-below" | nullish; /** * Contains authoring properties of visual variables generated from * one of the Smart Mapping methods or sliders. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfo.html#visualVariables Read more...} */ visualVariables?: AuthoringInfoVisualVariableProperties[]; } export interface AuthoringInfoField1Properties { field?: string; normalizationField?: string; classBreakInfos?: AuthoringInfoField1ClassBreakInfos[]; label?: string; } export interface AuthoringInfoField1 extends AnonymousAccessor { field: string; normalizationField: string; classBreakInfos: AuthoringInfoField1ClassBreakInfos[]; label: string; } export interface AuthoringInfoField1ClassBreakInfos { maxValue: number; minValue: number; } export interface AuthoringInfoField2Properties { field?: string; normalizationField?: string; classBreakInfos?: AuthoringInfoField2ClassBreakInfos[]; label?: string; } export interface AuthoringInfoField2 extends AnonymousAccessor { field: string; normalizationField: string; classBreakInfos: AuthoringInfoField2ClassBreakInfos[]; label: string; } export interface AuthoringInfoField2ClassBreakInfos { maxValue: number; minValue: number; } export interface AuthoringInfoStatistics { max: number; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#endTime Read more...} */ endTime: string | number | nullish; /** * Indicates the field name used for generating the data-driven visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#field Read more...} */ field: string | nullish; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue Read more...} */ maxSliderValue: number | nullish; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue Read more...} */ minSliderValue: number | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#normalizationField Read more...} */ normalizationField: string | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#referenceSizeScale Read more...} */ referenceSizeScale: number | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#referenceSizeSymbolStyle Read more...} */ referenceSizeSymbolStyle: "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square" | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `spike`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#spikeSymbolStyle Read more...} */ spikeSymbolStyle: | "triangle-closed-outline" | "triangle-gradient-fill-closed" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-open-outline" | "triangle-open-outline" | "triangle-solid-fill-closed" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-open-outline" | nullish; /** * If an age or timeline renderer was generated, indicates the start * time of the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#startTime Read more...} */ startTime: string | number | nullish; /** * If the UI offers the option to display values based on a ratio or * percentage, this indicates which selection was made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#style Read more...} */ style: "percent" | "percent-of-total" | "ratio" | nullish; /** * Indicates the theme selected by the user when generating a renderer * or visual variable with one of the Smart Mapping functions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme Read more...} */ theme: | "above" | "below" | "above-and-below" | "centered-on" | "extremes" | "high-to-low" | "reference-size" | "spike" | nullish; /** * The type of visual variable generated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#type Read more...} */ type: "color" | "size" | "opacity" | nullish; /** * If an age or timeline renderer was generated, indicates the time units used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#units Read more...} */ units: "seconds" | "minutes" | "hours" | "days" | "months" | "years" | nullish; /** * Contains authoring properties of visual variables generated from * one of the Smart Mapping methods or sliders. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html Read more...} */ constructor(properties?: AuthoringInfoVisualVariableProperties); /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size` or `spike`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#sizeStops Read more...} */ get sizeStops(): SizeStop[] | nullish; set sizeStops(value: SizeStopProperties[] | nullish); /** * Creates a deep clone of the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#clone Read more...} */ clone(): AuthoringInfoVisualVariable; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AuthoringInfoVisualVariable; } interface AuthoringInfoVisualVariableProperties { /** * If an age or timeline renderer was generated, indicates the end * time of the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#endTime Read more...} */ endTime?: string | number | nullish; /** * Indicates the field name used for generating the data-driven visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#field Read more...} */ field?: string | nullish; /** * Indicates the value of the upper handle if a slider was used to generate the visual variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#maxSliderValue Read more...} */ maxSliderValue?: number | nullish; /** * Indicates the value of the lower handle if a slider was used to generate the visual variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#minSliderValue Read more...} */ minSliderValue?: number | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#normalizationField Read more...} */ normalizationField?: string | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#referenceSizeScale Read more...} */ referenceSizeScale?: number | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#referenceSizeSymbolStyle Read more...} */ referenceSizeSymbolStyle?: "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square" | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `reference-size` or `spike`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#sizeStops Read more...} */ sizeStops?: SizeStopProperties[] | nullish; /** * Only applicable when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme theme} is `spike`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#spikeSymbolStyle Read more...} */ spikeSymbolStyle?: | "triangle-closed-outline" | "triangle-gradient-fill-closed" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-open-outline" | "triangle-open-outline" | "triangle-solid-fill-closed" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-open-outline" | nullish; /** * If an age or timeline renderer was generated, indicates the start * time of the visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#startTime Read more...} */ startTime?: string | number | nullish; /** * If the UI offers the option to display values based on a ratio or * percentage, this indicates which selection was made. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#style Read more...} */ style?: "percent" | "percent-of-total" | "ratio" | nullish; /** * Indicates the theme selected by the user when generating a renderer * or visual variable with one of the Smart Mapping functions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#theme Read more...} */ theme?: | "above" | "below" | "above-and-below" | "centered-on" | "extremes" | "high-to-low" | "reference-size" | "spike" | nullish; /** * The type of visual variable generated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#type Read more...} */ type?: "color" | "size" | "opacity" | nullish; /** * If an age or timeline renderer was generated, indicates the time units used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-AuthoringInfoVisualVariable.html#units Read more...} */ units?: "seconds" | "minutes" | "hours" | "days" | "months" | "years" | nullish; } export interface ClassBreakInfo extends Accessor, JSONSupport { } export class ClassBreakInfo { /** * Describes the data represented by the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#label Read more...} */ label: string | nullish; /** * Sets the maximum value for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#maxValue Read more...} */ maxValue: number; /** * Sets the minimum value for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#minValue Read more...} */ minValue: number; /** * Defines a class break for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html Read more...} */ constructor(properties?: ClassBreakInfoProperties); /** * Defines the symbol used to render features with data values that are within the bounds * defined for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#symbol Read more...} */ get symbol(): SymbolUnion; set symbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" })); /** * Creates a deep clone of the class break info object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#clone Read more...} */ clone(): ClassBreakInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ClassBreakInfo; } interface ClassBreakInfoProperties { /** * Describes the data represented by the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#label Read more...} */ label?: string | nullish; /** * Sets the maximum value for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#maxValue Read more...} */ maxValue?: number; /** * Sets the minimum value for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#minValue Read more...} */ minValue?: number; /** * Defines the symbol used to render features with data values that are within the bounds * defined for the class break. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ClassBreakInfo.html#symbol Read more...} */ symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }); } export interface ColormapInfo extends Accessor, JSONSupport { } export class ColormapInfo { /** * The label for a given pixel value and color mapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#label Read more...} */ label: string | nullish; /** * The raster pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#value Read more...} */ value: number; /** * The ColormapInfo describes pixel value, RGB colors and labels to color the raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html Read more...} */ constructor(properties?: ColormapInfoProperties); /** * The color of a given pixel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColormapInfo; } interface ColormapInfoProperties { /** * The color of a given pixel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#color Read more...} */ color?: ColorProperties; /** * The label for a given pixel value and color mapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#label Read more...} */ label?: string | nullish; /** * The raster pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-ColormapInfo.html#value Read more...} */ value?: number; } export class HeatmapColorStop extends Accessor { /** * The ratio of a pixel's density value to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#maxDensity maxDensity} of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#ratio Read more...} */ ratio: number; /** * This class is used to define an array of objects describing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer}'s color ramp * and associated density value ratios. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html Read more...} */ constructor(properties?: HeatmapColorStopProperties); /** * The color to shade a given pixel based on its calculated density {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#ratio ratio}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#color Read more...} */ get color(): Color; set color(value: ColorProperties | number[] | string); /** * Creates a deep clone of the color stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#clone Read more...} */ clone(): HeatmapColorStop; } interface HeatmapColorStopProperties { /** * The color to shade a given pixel based on its calculated density {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#ratio ratio}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#color Read more...} */ color?: ColorProperties | number[] | string; /** * The ratio of a pixel's density value to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#maxDensity maxDensity} of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-HeatmapColorStop.html#ratio Read more...} */ ratio?: number; } /** * Provides a utility method used to deserialize a JSON renderer object returned by the REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-jsonUtils.html Read more...} */ interface supportJsonUtils { /** * Creates a new instance of an appropriate {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/renderer-objects.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-jsonUtils.html#fromJSON Read more...} */ fromJSON(json: any): RendererUnion | nullish; } export const supportJsonUtils: supportJsonUtils; export interface RasterPresetRenderer extends Accessor, Clonable, JSONSupport { } export class RasterPresetRenderer { /** * The band ids associated with the raster renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#bandIds Read more...} */ bandIds: number[]; /** * Specifies how to match the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#renderer renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method Read more...} */ method: "raster-function-template" | "variable" | "none"; /** * The name of the preset renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#name Read more...} */ name: string; /** * The corresponding value of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method method}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#value Read more...} */ value: string; /** * Defines a predefined raster renderer associated with an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#presetRenderers ImageryLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#presetRenderers ImageryTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html Read more...} */ constructor(properties?: RasterPresetRendererProperties); /** * The raster renderer associated with the selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#value value} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method method}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#renderer Read more...} */ get renderer(): | ClassBreaksRenderer | UniqueValueRenderer | RasterStretchRenderer | RasterShadedReliefRenderer | RasterColormapRenderer | VectorFieldRenderer | FlowRenderer; set renderer(value: | (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" })); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterPresetRenderer; } interface RasterPresetRendererProperties { /** * The band ids associated with the raster renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#bandIds Read more...} */ bandIds?: number[]; /** * Specifies how to match the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#renderer renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method Read more...} */ method?: "raster-function-template" | "variable" | "none"; /** * The name of the preset renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#name Read more...} */ name?: string; /** * The raster renderer associated with the selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#value value} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method method}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#renderer Read more...} */ 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" }); /** * The corresponding value of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#method method}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-RasterPresetRenderer.html#value Read more...} */ value?: string; } export interface UniqueValue extends Accessor, JSONSupport { } export class UniqueValue { /** * Defines a value (possibly in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 value2} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 value3}) returned from the field * referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field UniqueValueRenderer.field} * or returned from an Arcade expression defined in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression UniqueValueRenderer.valueExpression} to be categorized * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value Read more...} */ value: string | number | nullish; /** * Defines a value returned from the field referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field2 UniqueValueRenderer.field2} * to be categorized in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value value} (and possibly {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 value3}) in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 Read more...} */ value2: string | number | nullish; /** * Defines a value returned from the field referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field3 UniqueValueRenderer.field3} * to be categorized in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value value} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 value2} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 Read more...} */ value3: string | number | nullish; /** * Defines combinations of values to expect from up to three fields of categorical data * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html UniqueValueRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html Read more...} */ constructor(properties?: UniqueValueProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UniqueValue; } interface UniqueValueProperties { /** * Defines a value (possibly in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 value2} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 value3}) returned from the field * referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field UniqueValueRenderer.field} * or returned from an Arcade expression defined in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression UniqueValueRenderer.valueExpression} to be categorized * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value Read more...} */ value?: string | number | nullish; /** * Defines a value returned from the field referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field2 UniqueValueRenderer.field2} * to be categorized in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value value} (and possibly {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 value3}) in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 Read more...} */ value2?: string | number | nullish; /** * Defines a value returned from the field referenced in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field3 UniqueValueRenderer.field3} * to be categorized in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value value} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value2 value2} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html UniqueValueClass}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValue.html#value3 Read more...} */ value3?: string | number | nullish; } export interface UniqueValueClass extends Accessor, Clonable, JSONSupport { } export class UniqueValueClass { /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values values} represented by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#symbol symbol} in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#label Read more...} */ label: string | nullish; /** * Defines a category within a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html UniqueValueGroup}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html Read more...} */ constructor(properties?: UniqueValueClassProperties); /** * Defines the symbol used to represent features containing the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values values}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#symbol Read more...} */ get symbol(): SymbolUnion | nullish; set symbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * An array of unique values that should be rendered with the same symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values Read more...} */ get values(): UniqueValue[] | nullish; set values(value: UniqueValueProperties[] | nullish | string | number); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UniqueValueClass; } interface UniqueValueClassProperties { /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values values} represented by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#symbol symbol} in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#label Read more...} */ label?: string | nullish; /** * Defines the symbol used to represent features containing the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values values}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#symbol Read more...} */ symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * An array of unique values that should be rendered with the same symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html#values Read more...} */ values?: UniqueValueProperties[] | nullish | string | number; } export interface UniqueValueGroup extends Accessor, Clonable, JSONSupport { } export class UniqueValueGroup { /** * The heading to be displayed for the group of unique classes in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#heading Read more...} */ heading: string | nullish; /** * UniqueValueGroup represents a group of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueClass.html unique value classes} * (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html Read more...} */ constructor(properties?: UniqueValueGroupProperties); /** * Specifies the classes (or unique categories) to group under a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#heading heading}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#classes Read more...} */ get classes(): UniqueValueClass[] | nullish; set classes(value: UniqueValueClassProperties[] | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UniqueValueGroup; } interface UniqueValueGroupProperties { /** * Specifies the classes (or unique categories) to group under a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#heading heading}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#classes Read more...} */ classes?: UniqueValueClassProperties[] | nullish; /** * The heading to be displayed for the group of unique classes in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueGroup.html#heading Read more...} */ heading?: string | nullish; } export interface UniqueValueInfo extends Accessor, JSONSupport { } export class UniqueValueInfo { /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value value} represented by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#label Read more...} */ label: string | nullish; /** * Features with this value will be rendered with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value Read more...} */ value: string | number; /** * Defines the categories of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html UniqueValueRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html Read more...} */ constructor(properties?: UniqueValueInfoProperties); /** * Defines the symbol used to render features with the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol Read more...} */ get symbol(): SymbolUnion | nullish; set symbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * Creates a deep clone of the unique value info object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#clone Read more...} */ clone(): UniqueValueInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): UniqueValueInfo; } interface UniqueValueInfoProperties { /** * Describes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value value} represented by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#label Read more...} */ label?: string | nullish; /** * Defines the symbol used to render features with the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol Read more...} */ symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * Features with this value will be rendered with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#symbol symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-UniqueValueInfo.html#value Read more...} */ value?: string | number; } /** * Various utilities for accessing renderer colors that match to fields, Arcade expressions, or values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html Read more...} */ interface utils { /** * Resolves with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#FieldToValueColorMap FieldToValueColorMap} that contains the fields and a map of values to its matched color in the renderer. * * @param renderer The renderer from which to match values with their associated colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#getColorsForRendererValues Read more...} */ 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. * * @param renderer The renderer from which to extract fields and their associated matching colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#getColorsFromRenderer Read more...} */ getColorsFromRenderer(renderer: | ClassBreaksRenderer | DotDensityRenderer | HeatmapRenderer | PieChartRenderer | SimpleRenderer | UniqueValueRenderer): Promise>; } export const utils: utils; /** * A mapping of the field or Arcade expression to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#ValueToColorMap ValueToColorMap} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#FieldToValueColorMap Read more...} */ export type FieldToValueColorMap = globalThis.Map; /** * A Map object that holds a renderer value and its corresponding color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-support-utils.html#ValueToColorMap Read more...} */ export type ValueToColorMap = globalThis.Map; export interface UniqueValueRenderer extends Renderer, VisualVariablesMixin { } export class UniqueValueRenderer { /** * The label used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} to describe features assigned the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultSymbol default symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultLabel Read more...} */ defaultLabel: string | nullish; /** * The name of the attribute field containing types or categorical values referenced * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups uniqueValueGroups}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field Read more...} */ field: string | nullish; /** * Specifies the name of an additional attribute field used to categorize features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field2 Read more...} */ field2: string | nullish; /** * Specifies the name of a third attribute field used to categorize features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field3 Read more...} */ field3: string | nullish; /** * A string used as a separator between the values in the legend * if multiple attribute fields are used to categorize values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#fieldDelimiter Read more...} */ fieldDelimiter: string | nullish; /** * Indicates whether the order of the classes or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} in the renderer definition * should be used for the feature drawing order of the layer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#orderByClassesEnabled Read more...} */ orderByClassesEnabled: boolean; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#type Read more...} */ readonly type: "unique-value"; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle: string | nullish; /** * UniqueValueRenderer allows you to symbolize features in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} based on one * or more categorical attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html Read more...} */ constructor(properties?: UniqueValueRendererProperties); /** * This property is only relevant when symbolizing polygon features with marker symbols * (or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html IconSymbol3DLayer}) in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} of this renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#backgroundFillSymbol Read more...} */ get backgroundFillSymbol(): FillSymbol | PolygonSymbol3D | CIMSymbol | nullish; set backgroundFillSymbol(value: | FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * The symbol used to draw * all features with values not referenced by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups uniqueValueGroups}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultSymbol Read more...} */ get defaultSymbol(): SymbolUnion | nullish; set defaultSymbol(value: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish); /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#legendOptions Read more...} */ get legendOptions(): UniqueValueRendererLegendOptions | nullish; set legendOptions(value: UniqueValueRendererLegendOptionsProperties | nullish); /** * An array of objects defining groups of unique values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups Read more...} */ get uniqueValueGroups(): UniqueValueGroup[] | nullish; set uniqueValueGroups(value: UniqueValueGroupProperties[] | nullish); /** * Defines categories and their corresponding symbols based on a set of values expected * from the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field field} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression valueExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos Read more...} */ get uniqueValueInfos(): UniqueValueInfo[] | nullish; set uniqueValueInfos(value: UniqueValueInfoProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Adds a unique value and symbol to the renderer. * * @param valueOrInfo The value to match. The value can be provided as an individual argument or as an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos info object described in uniqueValueInfos}. * @param symbol The symbol used to represent features matching the specified `value`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#addUniqueValueInfo Read more...} */ addUniqueValueInfo(valueOrInfo: string | number | any, symbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" })): void; /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#clone Read more...} */ clone(): UniqueValueRenderer; /** * Returns rendering and legend information (as defined by the renderer) associated with the given graphic. * * @param graphic The graphic whose rendering and legend information will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#getUniqueValueInfo Read more...} */ getUniqueValueInfo(graphic: Graphic): Promise; /** * Removes a unique value from the renderer. * * @param value Value to remove from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#removeUniqueValueInfo Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html IconSymbol3DLayer}) in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} of this renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#backgroundFillSymbol Read more...} */ backgroundFillSymbol?: | FillSymbolProperties | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * The label used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} to describe features assigned the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultSymbol default symbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultLabel Read more...} */ defaultLabel?: string | nullish; /** * The symbol used to draw * all features with values not referenced by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups uniqueValueGroups}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#defaultSymbol Read more...} */ defaultSymbol?: | (PictureFillSymbolProperties & { type: "picture-fill" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (SimpleLineSymbolProperties & { type: "simple-line" }) | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (LabelSymbol3DProperties & { type: "label-3d" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (MeshSymbol3DProperties & { type: "mesh-3d" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (WebStyleSymbolProperties & { type: "web-style" }) | nullish; /** * The name of the attribute field containing types or categorical values referenced * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups uniqueValueGroups}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field Read more...} */ field?: string | nullish; /** * Specifies the name of an additional attribute field used to categorize features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field2 Read more...} */ field2?: string | nullish; /** * Specifies the name of a third attribute field used to categorize features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field3 Read more...} */ field3?: string | nullish; /** * A string used as a separator between the values in the legend * if multiple attribute fields are used to categorize values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#fieldDelimiter Read more...} */ fieldDelimiter?: string | nullish; /** * An object providing options for displaying the renderer in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#legendOptions Read more...} */ legendOptions?: UniqueValueRendererLegendOptionsProperties | nullish; /** * Indicates whether the order of the classes or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos uniqueValueInfos} in the renderer definition * should be used for the feature drawing order of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#orderByClassesEnabled Read more...} */ orderByClassesEnabled?: boolean; /** * An array of objects defining groups of unique values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueGroups Read more...} */ uniqueValueGroups?: UniqueValueGroupProperties[] | nullish; /** * Defines categories and their corresponding symbols based on a set of values expected * from the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#field field} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression valueExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#uniqueValueInfos Read more...} */ uniqueValueInfos?: UniqueValueInfoProperties[] | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression Read more...} */ valueExpression?: string | nullish; /** * The title identifying and describing the associated {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} * expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#valueExpressionTitle Read more...} */ valueExpressionTitle?: string | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface UniqueValueRendererLegendOptionsProperties { title?: string | nullish; } export interface UniqueValueRendererLegendOptions extends AnonymousAccessor { title: string | nullish; } export interface VectorFieldRenderer extends Accessor, JSONSupport { } export class VectorFieldRenderer { /** * Attribute field presenting the magnitude. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#attributeField Read more...} */ attributeField: "Magnitude"; /** * Defines the flow direction of the data. * * @default "flow-from" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#flowRepresentation Read more...} */ flowRepresentation: "flow-from" | "flow-to"; /** * Predefined symbol styles used to represent the vector flow. * * @default "single-arrow" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#style Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#symbolTileSize Read more...} */ symbolTileSize: number; /** * The type of Renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#type Read more...} */ readonly type: "vector-field"; /** * The VectorFieldRenderer allows you to display your raster data with vector symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html Read more...} */ constructor(properties?: VectorFieldRendererProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#visualVariables Read more...} */ get visualVariables(): VisualVariable[] | nullish; set visualVariables(value: VisualVariableProperties[] | nullish); /** * Creates a deep clone of the renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#clone Read more...} */ clone(): VectorFieldRenderer; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): VectorFieldRenderer; } interface VectorFieldRendererProperties { /** * Attribute field presenting the magnitude. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#attributeField Read more...} */ attributeField?: "Magnitude"; /** * Defines the flow direction of the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#flowRepresentation Read more...} */ flowRepresentation?: "flow-from" | "flow-to"; /** * Predefined symbol styles used to represent the vector flow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#style Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#symbolTileSize Read more...} */ symbolTileSize?: number; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html VisualVariable} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html#visualVariables Read more...} */ visualVariables?: VisualVariableProperties[] | nullish; } export interface ColorVariable extends VisualVariable, JSONSupport { } export class ColorVariable { /** * Name of the numeric attribute field by which to normalize * the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#normalizationField Read more...} */ normalizationField: string | nullish; /** * The visual variable type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#type Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#field field} or an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#valueExpression expression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html Read more...} */ constructor(properties?: ColorVariableProperties); /** * An array of sequential objects, or stops, that defines a continuous color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#stops Read more...} */ get stops(): ColorStop[]; set stops(value: ColorStopProperties[]); /** * Creates a deep clone of the ColorVariable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#clone Read more...} */ clone(): ColorVariable; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColorVariable; } interface ColorVariableProperties extends VisualVariableProperties { /** * Name of the numeric attribute field by which to normalize * the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#normalizationField Read more...} */ normalizationField?: string | nullish; /** * An array of sequential objects, or stops, that defines a continuous color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#stops Read more...} */ stops?: ColorStopProperties[]; } export interface OpacityVariable extends VisualVariable, JSONSupport { } export class OpacityVariable { /** * Name of the numeric attribute field by which to normalize * the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#normalizationField Read more...} */ normalizationField: string | nullish; /** * The visual variable type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#type Read more...} */ readonly type: "opacity"; /** * The opacity visual variable defines the opacity of each feature's symbol based on a numeric * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#field field} value or number returned from an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#valueExpression expression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html Read more...} */ constructor(properties?: OpacityVariableProperties); /** * An array of objects that defines the opacity to apply to features in a layer in a sequence of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#stops Read more...} */ get stops(): OpacityStop[]; set stops(value: OpacityStopProperties[]); /** * Creates a deep clone of the OpacityVariable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#clone Read more...} */ clone(): OpacityVariable; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): OpacityVariable; } interface OpacityVariableProperties extends VisualVariableProperties { /** * Name of the numeric attribute field by which to normalize * the data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#normalizationField Read more...} */ normalizationField?: string | nullish; /** * An array of objects that defines the opacity to apply to features in a layer in a sequence of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#stops Read more...} */ stops?: OpacityStopProperties[]; } export interface RotationVariable extends VisualVariable, JSONSupport { } export class RotationVariable { /** * Only applicable when working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} with an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html ObjectSymbol3DLayer}. * * @default "heading" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#axis Read more...} */ axis: "heading" | "tilt" | "roll"; /** * Defines the origin and direction of rotation depending * on how the angle of rotation was measured. * * @default "geographic" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#rotationType Read more...} */ rotationType: "geographic" | "arithmetic"; /** * The visual variable type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#type Read more...} */ readonly type: "rotation"; /** * The rotation visual variable, determined by mapping the values to data in a field or * by other arithmetic means with an Arcade expression, controls how features rendered with * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html marker symbols} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html text symbols} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} , * as well as with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html marker symbols}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html ObjectSymbol3DLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html IconSymbol3DLayer} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}, * are rotated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html Read more...} */ constructor(properties?: RotationVariableProperties); /** * Creates a deep clone of the RotationVariable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#clone Read more...} */ clone(): RotationVariable; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RotationVariable; } interface RotationVariableProperties extends VisualVariableProperties { /** * Only applicable when working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} with an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html ObjectSymbol3DLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#axis Read more...} */ axis?: "heading" | "tilt" | "roll"; /** * Defines the origin and direction of rotation depending * on how the angle of rotation was measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-RotationVariable.html#rotationType Read more...} */ rotationType?: "geographic" | "arithmetic"; } export interface SizeVariable extends VisualVariable, JSONSupport { } export class SizeVariable { /** * Only applicable when working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default "all" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#axis Read more...} */ axis: "width" | "depth" | "height" | "width-and-depth" | "all"; /** * The maximum data value used in the size ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#maxDataValue Read more...} */ maxDataValue: number | nullish; /** * The minimum data value used in the size ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#minDataValue Read more...} */ minDataValue: number | nullish; /** * The name of the numeric attribute field used to normalize * the data in the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#normalizationField Read more...} */ normalizationField: string | nullish; /** * This value must be `outline` when scaling polygon outline widths * based on the view scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#target Read more...} */ target: string | nullish; /** * The visual variable type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#type Read more...} */ readonly type: "size"; /** * When setting a size visual variable on a renderer using an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html ObjectSymbol3DLayer}, this property indicates whether to apply the value * defined by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#height height}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#width width}, or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#depth depth} properties to the corresponding {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#axis axis} of * this visual variable instead of proportionally scaling this axis' value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#useSymbolValue Read more...} */ useSymbolValue: boolean | nullish; /** * Specifies how to apply the data value when mapping real-world sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueRepresentation Read more...} */ valueRepresentation: "radius" | "diameter" | "area" | "width" | "distance" | nullish; /** * Indicates the unit of measurement used to interpret the value returned by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueExpression valueExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueUnit Read more...} */ valueUnit: | "unknown" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers"; /** * The size visual variable defines the size of individual features in a layer based * on a numeric (often thematic) value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html Read more...} */ constructor(properties?: SizeVariableProperties); /** * The size used to render a feature containing the maximum data value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#maxSize Read more...} */ get maxSize(): number | SizeVariable | nullish; set maxSize(value: number | SizeVariableProperties | nullish | string); /** * The size used to render a feature containing the minimum data value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#minSize Read more...} */ get minSize(): number | SizeVariable | nullish; set minSize(value: number | SizeVariableProperties | nullish | string); /** * An array of objects that defines the mapping of data values returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueExpression valueExpression} to icon sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#stops Read more...} */ get stops(): SizeStop[] | nullish; set stops(value: SizeStopProperties[] | nullish); /** * Creates a deep clone of the SizeVisualVariable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#clone Read more...} */ clone(): SizeVariable; /** * Modifies the SizeVariable in place by flipping the sizes in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#flipSizes Read more...} */ flipSizes(): void; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SizeVariable; } interface SizeVariableProperties extends VisualVariableProperties { /** * Only applicable when working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#axis Read more...} */ axis?: "width" | "depth" | "height" | "width-and-depth" | "all"; /** * The maximum data value used in the size ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#maxDataValue Read more...} */ maxDataValue?: number | nullish; /** * The size used to render a feature containing the maximum data value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#maxSize Read more...} */ maxSize?: number | SizeVariableProperties | nullish | string; /** * The minimum data value used in the size ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#minDataValue Read more...} */ minDataValue?: number | nullish; /** * The size used to render a feature containing the minimum data value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#minSize Read more...} */ minSize?: number | SizeVariableProperties | nullish | string; /** * The name of the numeric attribute field used to normalize * the data in the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#normalizationField Read more...} */ normalizationField?: string | nullish; /** * An array of objects that defines the mapping of data values returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueExpression valueExpression} to icon sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#stops Read more...} */ stops?: SizeStopProperties[] | nullish; /** * This value must be `outline` when scaling polygon outline widths * based on the view scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#target Read more...} */ target?: string | nullish; /** * When setting a size visual variable on a renderer using an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html ObjectSymbol3DLayer}, this property indicates whether to apply the value * defined by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#height height}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#width width}, or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#depth depth} properties to the corresponding {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#axis axis} of * this visual variable instead of proportionally scaling this axis' value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#useSymbolValue Read more...} */ useSymbolValue?: boolean | nullish; /** * Specifies how to apply the data value when mapping real-world sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueRepresentation Read more...} */ valueRepresentation?: "radius" | "diameter" | "area" | "width" | "distance" | nullish; /** * Indicates the unit of measurement used to interpret the value returned by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#field field} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueExpression valueExpression}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#valueUnit Read more...} */ valueUnit?: | "unknown" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers"; } /** * Defines a size visual variable with minimum and maximum bounds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#BoundedMinMax Read more...} */ export interface BoundedMinMax { type: string; field?: string; normalizationField?: string; valueExpression?: string; valueExpressionTitle?: string; maxDataValue: number; maxSize: string | number; minDataValue: number; minSize: string | number; } /** * Defines a size visual variable where data values are interpreted as * real-world sizes based on a given unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#RealWorldSize Read more...} */ export interface RealWorldSize { axis?: string; type: string; field?: string; normalizationField?: string; valueExpression?: string; valueUnit?: string; valueRepresentation?: string; } /** * Defines icon sizes in a size visual variable based on minimum and maximum * bounds similar to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#BoundedMinMax BoundedMinMax} case. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons Read more...} */ export interface ScaleDependentIcons { type: string; field?: string; normalizationField?: string; valueExpression?: string; maxDataValue: number; maxSize: ScaleDependentStops; minDataValue: number; minSize: ScaleDependentStops; } /** * Defines feature sizes and outline widths in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#SizeVisualVariable size visual variable} * based on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale MapView.scale}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ScaleDependentStops Read more...} */ export interface ScaleDependentStops { type: "size"; valueExpression: string | nullish; target?: "outline" | nullish; stops: SizeStop[] | nullish; } /** * Defines two or more stops at which feature sizes are mapped to data values in a * size visual variable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ThematicStops Read more...} */ export interface ThematicStops { type: string; field?: string; normalizationField?: string; valueExpression?: string; stops: SizeStop[]; } export interface ColorSizeStop extends Accessor, JSONSupport { } export class ColorSizeStop { /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#label Read more...} */ label: string | nullish; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#size size} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value Read more...} */ value: number; /** * Defines how to data values should be represented in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html ColorSizeSlider} with an associated color and size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html Read more...} */ constructor(properties?: ColorSizeStopProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * The size value in points used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the ColorSizeStop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#clone Read more...} */ clone(): ColorSizeStop; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColorSizeStop; } interface ColorSizeStopProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#color Read more...} */ color?: ColorProperties; /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#label Read more...} */ label?: string | nullish; /** * The size value in points used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#size Read more...} */ size?: number | string; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#size size} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorSizeStop.html#value Read more...} */ value?: number; } export interface ColorStop extends Accessor, JSONSupport { } export class ColorStop { /** * A string value used to label the stop along the color ramp in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#label Read more...} */ label: string | nullish; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#value Read more...} */ value: number; /** * Defines a color stop used for creating a continuous color visualization in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html#stops color visual variable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html Read more...} */ constructor(properties?: ColorStopProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Creates a deep clone of the ColorStop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#clone Read more...} */ clone(): ColorStop; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColorStop; } interface ColorStopProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#color Read more...} */ color?: ColorProperties; /** * A string value used to label the stop along the color ramp in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#label Read more...} */ label?: string | nullish; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#color color}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-ColorStop.html#value Read more...} */ value?: number; } export interface OpacityStop extends Accessor, JSONSupport { } export class OpacityStop { /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#label Read more...} */ label: string | nullish; /** * The opacity value (between `0.0` and `1.0`) used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#opacity Read more...} */ opacity: number; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#opacity opacity value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#value Read more...} */ value: number; /** * Defines an opacity stop used for creating a continuous opacity visualization in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html#stops opacity visual variable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html Read more...} */ constructor(properties?: OpacityStopProperties); /** * Creates a deep clone of the OpacityStop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#clone Read more...} */ clone(): OpacityStop; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): OpacityStop; } interface OpacityStopProperties { /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#label Read more...} */ label?: string | nullish; /** * The opacity value (between `0.0` and `1.0`) used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#opacity Read more...} */ opacity?: number; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#opacity opacity value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-OpacityStop.html#value Read more...} */ value?: number; } export interface SizeStop extends Accessor, JSONSupport { } export class SizeStop { /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#label Read more...} */ label: string | nullish; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#size size}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#value Read more...} */ value: number; /** * Defines a size stop used for creating a continuous size visualization in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#stops size visual variable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html Read more...} */ constructor(properties?: SizeStopProperties); /** * The size value in points (between `0` and `90`) used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the SizeStop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#clone Read more...} */ clone(): SizeStop; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SizeStop; } interface SizeStopProperties { /** * A string value used to label the stop in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#label Read more...} */ label?: string | nullish; /** * The size value in points (between `0` and `90`) used to render features with the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#size Read more...} */ size?: number | string; /** * Specifies the data value to map to the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#size size}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-support-SizeStop.html#value Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#field Read more...} */ field: string; /** * The visual variable type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#type Read more...} */ readonly type: "color" | "opacity" | "rotation" | "size" | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpression Read more...} */ valueExpression: string | nullish; /** * The title identifying and describing the associated * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpressionTitle Read more...} */ valueExpressionTitle: string | nullish; /** * The visual variable base class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html Read more...} */ constructor(properties?: VisualVariableProperties); /** * An object providing options for displaying the visual variable in * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#legendOptions Read more...} */ get legendOptions(): VisualVariableLegendOptions | nullish; set legendOptions(value: VisualVariableLegendOptionsProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#field Read more...} */ field?: string; /** * An object providing options for displaying the visual variable in * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#legendOptions Read more...} */ legendOptions?: VisualVariableLegendOptionsProperties | nullish; /** * An {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression following the specification * defined by the {@link https://doc.geoscene.cn/javascript/4.33/arcade/#visualization Arcade Visualization Profile}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpression Read more...} */ valueExpression?: string | nullish; /** * The title identifying and describing the associated * {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression as defined in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpression valueExpression} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-VisualVariable.html#valueExpressionTitle Read more...} */ valueExpressionTitle?: string | nullish; } export interface VisualVariableLegendOptionsProperties { showLegend?: boolean | nullish; title?: string | nullish; } export interface VisualVariableLegendOptions extends AnonymousAccessor { showLegend: boolean | nullish; title: string | nullish; } /** * ClassBreaksRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/ClassBreaksRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#ClassBreaksRenderer Read more...} */ export type renderersClassBreaksRenderer = ClassBreaksRenderer; /** * DictionaryRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/DictionaryRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#DictionaryRenderer Read more...} */ export type renderersDictionaryRenderer = DictionaryRenderer; /** * DotDensityRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/DotDensityRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#DotDensityRenderer Read more...} */ export type renderersDotDensityRenderer = DotDensityRenderer; /** * HeatmapRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/HeatmapRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#HeatmapRenderer Read more...} */ export type renderersHeatmapRenderer = HeatmapRenderer; /** * PieChartRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/PieChartRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#PieChartRenderer Read more...} */ export type renderersPieChartRenderer = PieChartRenderer; /** * Renderer. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~RendererUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#Renderer Read more...} */ export type renderersRenderer = HeatmapRenderer | RendererWithVisualVariables; /** * RendererWithVisualVariables. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~RendererWithVisualVariablesUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#RendererWithVisualVariables Read more...} */ export type RendererWithVisualVariables = | SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | DotDensityRenderer | DictionaryRenderer | PieChartRenderer; /** * SimpleRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/SimpleRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#SimpleRenderer Read more...} */ export type renderersSimpleRenderer = SimpleRenderer; /** * UniqueValueRenderer. * * @deprecated since version 4.32. Import {@link module:geoscene/renderers/UniqueValueRenderer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers.html#UniqueValueRenderer Read more...} */ export type renderersUniqueValueRenderer = UniqueValueRenderer; /** * Retrieves data from a remote server or uploads a file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html Read more...} */ interface request { /** * Retrieves data from a remote server or uploads a file from a user's computer. * * @param url The request URL. * @param options The options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request Read more...} */ request(url: string | URL, options?: RequestOptions): Promise; } const __requestMapped: request; export const request: typeof __requestMapped.request; /** * The specification of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html#details details object} returned in an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html Error} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#GeoSceneErrorDetails Read more...} */ export interface GeoSceneErrorDetails { getHeader: GetHeader; getAllHeaders: GetAllHeaders; httpStatus: number; messageCode: string; messages: string[]; raw: any | string; requestOptions: RequestOptions; ssl: boolean; subCode: number; url: string; } export type GetAllHeaders = () => [string, string][] | nullish; export type GetHeader = (headerName: string) => string | nullish; /** * An object with the following properties that describe the request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions Read more...} */ export interface RequestOptions { authMode?: "auto" | "anonymous" | "immediate" | "no-prompt"; body?: FormData | HTMLFormElement | string | nullish; cacheBust?: boolean; headers?: any; method?: "auto" | "delete" | "head" | "post" | "put"; query?: any | URLSearchParams; responseType?: | "json" | "text" | "array-buffer" | "blob" | "image" | "native" | "native-request-init" | "document" | "xml"; signal?: AbortSignal | nullish; timeout?: number; useProxy?: boolean; withCredentials?: boolean; } /** * Returns a promise that resolves to an object with the following specification. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestResponse Read more...} */ export interface RequestResponse { data: any; getHeader?: GetHeader; getAllHeaders?: GetAllHeaders; httpStatus?: number; requestOptions?: RequestOptions; ssl?: boolean; url?: string; } /** * Helps you find closest facilities around any location (incident) on a network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html Read more...} */ interface closestFacility { /** * Solves the closest facility. * * @param url URL to the GeoScene Server REST resource that represents a network analysis service. * @param params Defines the parameters of the closest facility analysis. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html#solve Read more...} */ solve(url: string, params: ClosestFacilityParameters, requestOptions?: any | nullish): Promise; } export const closestFacility: closestFacility; export class FeatureService { /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#capabilities Read more...} */ readonly capabilities: FeatureServiceCapabilities | nullish; /** * Describes effective capabilities of the service taking in to consideration privileges of the currently signed-in user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#effectiveCapabilities Read more...} */ readonly effectiveCapabilities: FeatureServiceCapabilities | nullish; /** * Contains info of all layers in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#layerInfos Read more...} */ layerInfos: FeatureServiceLayerInfo[]; /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#loadError Read more...} */ readonly loadError: Error | nullish; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#loadStatus Read more...} */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * Contains info of all tables in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#tableInfos Read more...} */ tableInfos: TableInfo[]; /** * The absolute URL of the REST endpoint for the feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#url Read more...} */ url: string; /** * Describes the service's userTypeExtensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#userTypeExtensions Read more...} */ userTypeExtensions: string[]; /** * The url that points to the utility network layer, if it exists. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#utilityNetworkUrl Read more...} */ readonly utilityNetworkUrl: string | nullish; /** * The url to the version management service, if the data is versioned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#versionManagementServiceUrl Read more...} */ readonly versionManagementServiceUrl: string | nullish; constructor(properties?: any); /** * Applies edits to features in the feature service layers. * * @param edits Object containing features and attachments to be added, updated or deleted. * @param options Additional edit options to specify when editing features or attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#applyEdits Read more...} */ applyEdits(edits: FeatureServiceApplyEditsEdits[], options?: FeatureServiceApplyEditsOptions): Promise; /** * Triggers the loading of the feature service instance and fetches all layers and tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#fetchAllLayersAndTables Read more...} */ fetchAllLayersAndTables(): Promise; /** * Triggers the loading of the feature service instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#load Read more...} */ load(): Promise; } /** * Describes the layer's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#Capabilities Read more...} */ export interface FeatureServiceCapabilities { data: FeatureServiceCapabilitiesData; editing: FeatureServiceCapabilitiesEditing; operations: FeatureServiceCapabilitiesOperations; query: FeatureServiceCapabilitiesQuery; sync: CapabilitiesSync; } export interface FeatureServiceApplyEditsEdits { id: number; identifierFields: FeatureServiceApplyEditsEditsIdentifierFields; addFeatures?: Graphic[] | Collection; updateFeatures?: Graphic[] | Collection; deleteFeatures?: Graphic[] | Collection | any[]; addAttachments?: AttachmentEdit[]; updateAttachments?: AttachmentEdit[]; deleteAttachments?: string[]; } export interface FeatureServiceApplyEditsEditsIdentifierFields { globalIdField: string | nullish; objectIdField: string; } export interface FeatureServiceApplyEditsOptions { gdbVersion?: string; globalIdUsed?: boolean; honorSequenceOfEdits?: boolean; usePreviousEditMoment?: boolean; } /** * Contains information for a layer in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#LayerDefinition Read more...} */ export interface LayerDefinition { id: number; name: string; type: string; url: string; geometryType?: "point" | "polyline" | "polygon" | "envelope" | "multipoint"; capabilities: Capabilities; } /** * Contains information for a layer in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#LayerInfo Read more...} */ export interface FeatureServiceLayerInfo { id: number; name: string; type: string; url: string; geometryType?: "point" | "polyline" | "polygon" | "envelope" | "multipoint"; } /** * Contains information returned from the service containing layerInfos, tableInfos, and server capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#ServiceContents Read more...} */ export interface ServiceContents { layers: LayerDefinition[]; tables: TableDefinition[]; } /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#applyEdits applyEdits} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#ServiceEditsResult Read more...} */ export interface ServiceEditsResult { id: number; addFeatureResults: any[]; updateFeatureResults: any[]; deleteFeatureResults: any[]; addAttachmentResults: any[]; updateAttachmentResults: any[]; deleteAttachmentResults: any[]; editedFeatures?: any; editMoment?: number; } /** * Contains information for a table in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#TableDefinition Read more...} */ export interface TableDefinition { id: number; name: string; type: string; url: string; capabilities: Capabilities; } /** * Contains information for a table in the Feature Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html#TableInfo Read more...} */ export interface TableInfo { id: number; name: string; type: string; url: string; } export interface FeatureServiceCapabilitiesData { isDataVersioned: boolean; isDataBranchVersioned: boolean; } export interface FeatureServiceCapabilitiesEditing { supportsGlobalId: boolean; supportsReturnServiceEditsInSourceSpatialReference: boolean; supportsAsyncApplyEdits: boolean; supportsSplit: boolean; } export interface FeatureServiceCapabilitiesOperations { supportsAdd: boolean; supportsChangeTracking: boolean; supportsDelete: boolean; supportsEditing: boolean; supportsQuery: boolean; supportsQueryDataElements: boolean; supportsQueryDomains: boolean; supportsQueryContingentValues: boolean; supportsSync: boolean; supportsUpdate: boolean; } export interface FeatureServiceCapabilitiesQuery { maxRecordCount: number | nullish; maxRecordCountFactor: number | nullish; } export interface CapabilitiesSync { supportsAsync: boolean; supportedSyncDataOptions: CapabilitiesSyncSupportedSyncDataOptions; } export interface CapabilitiesSyncSupportedSyncDataOptions { annotations: boolean; dimensions: boolean; contingentValues: boolean; attributeRules: boolean; utilityNetworkSystem: boolean; annotationFullModel: boolean; include3DObjects: boolean; utilityNetworkMissingLayers: boolean; preserveTrueCurves: boolean; } /** * Provides utility methods for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html FeatureServices}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-utils.html Read more...} */ interface featureServiceUtils { /** * Used to create an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html FeatureService} from an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers}. * * @param layers Layers used to construct the FeatureService. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-utils.html#createFeatureServices Read more...} */ createFeatureServices(layers: Iterable): globalThis.Map; } export const featureServiceUtils: featureServiceUtils; /** * Results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-utils.html#createFeatureService createFeatureService} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-utils.html#FeatureServiceResourcesBundle Read more...} */ export interface FeatureServiceResourcesBundle { featureService: FeatureService; layers: (FeatureLayer | SubtypeGroupLayer)[]; } /** * Search a map service exposed by the GeoScene Server REST API based on a string value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-find.html Read more...} */ interface find { /** * Sends a request to the GeoScene REST map service resource to perform a search based on the input * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html params}. * * @param url URL to the GeoScene Server REST resource that represents a map service. * @param params Specifies the layers and fields that are used for the search. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-find.html#find Read more...} */ find(url: string, params: FindParametersProperties, requestOptions?: RequestOptions): Promise; } export const find: find; /** * Represents geometry service resources exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html Read more...} */ interface geometryService { /** * Computes the area and length for the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygons}. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param areasAndLengthsParameters Specify the input polygons and optionally the linear and area units. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#areasAndLengths Read more...} */ areasAndLengths(url: string, areasAndLengthsParameters: AreasAndLengthsParameters, requestOptions?: RequestOptions): Promise; /** * The Auto Complete operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param polygons The array of polygons that will provide boundaries for new polygons. * @param polylines An array of polylines that will provide the remaining boundaries for new polygons. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#autoComplete Read more...} */ autoComplete(url: string, polygons: Polygon[], polylines: Polyline[], requestOptions?: RequestOptions): Promise; /** * Creates buffer polygons at a specified distance around the given geometries. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param bufferParameters Specifies the input geometries, buffer distances, and other options. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#buffer Read more...} */ buffer(url: string, bufferParameters: BufferParameters, requestOptions?: RequestOptions): Promise; /** * The convexHull operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries The geometries whose convex hull is to be created. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#convexHull Read more...} */ convexHull(url: string, geometries: GeometryUnion[], requestOptions?: RequestOptions): Promise; /** * The cut operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries The polylines or polygons to be cut. * @param cutter The polyline that will be used to divide the target into pieces where it crosses the target. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#cut Read more...} */ cut(url: string, geometries: GeometryUnion[], cutter: Polyline, requestOptions?: RequestOptions): Promise; /** * The densify operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param densifyParameters The DensifyParameters objects contains `geometries`, `geodesic`, `lengthUnit`, and `maxSegmentLength` properties. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#densify Read more...} */ densify(url: string, densifyParameters: DensifyParameters, requestOptions?: RequestOptions): Promise; /** * The difference operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries An array of points, multipoints, polylines or polygons. * @param geometry A single geometry of any type, with a dimension equal to or greater than the items in geometries. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#difference Read more...} */ difference(url: string, geometries: GeometryUnion[], geometry: GeometryUnion, requestOptions?: RequestOptions): Promise; /** * Measures the planar or geodesic distance between geometries. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param distanceParameters Sets the input geometries to measure, distance units, and other parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#distance Read more...} */ distance(url: string, distanceParameters: DistanceParameters, requestOptions?: RequestOptions): Promise; /** * Converts an array of well-known strings into xy-coordinates based on the conversion type and spatial * reference supplied by the user. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param params See the object specifications table below for the structure of the `params` object. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#fromGeoCoordinateString Read more...} */ fromGeoCoordinateString(url: string, params: geometryServiceFromGeoCoordinateStringParams, requestOptions?: RequestOptions): Promise; /** * Generalizes the input geometries using the Douglas-Peucker algorithm. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param generalizeParameters An array of geometries to generalize and a maximum deviation. Optionally set the deviation units. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#generalize Read more...} */ generalize(url: string, generalizeParameters: GeneralizeParameters, requestOptions?: RequestOptions): Promise; /** * The intersect operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries An array of points, multipoints, polylines, or polygons. * @param intersector A single geometry of any type, of dimension equal to or greater than the dimension of the items in `geometries`. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#intersect Read more...} */ intersect(url: string, geometries: GeometryUnion[], intersector: GeometryUnion, requestOptions?: RequestOptions): Promise; /** * Calculates an interior point for each polygon specified. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param polygons The polygon graphics to process. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#labelPoints Read more...} */ labelPoints(url: string, polygons: Polygon[], requestOptions?: RequestOptions): Promise; /** * Gets the lengths for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} when the geometry type is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline}. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param lengthsParameters Specify the polylines and optionally the length unit and the geodesic length option. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#lengths Read more...} */ lengths(url: string, lengthsParameters: LengthsParameters, requestOptions?: RequestOptions): Promise; /** * Constructs the offset of the input geometries based on a planar distance. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param offsetParameters Set the geometries to offset, distance, and units. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#offset Read more...} */ offset(url: string, offsetParameters: OffsetParameters, requestOptions?: RequestOptions): Promise; /** * Projects a set of geometries to a new spatial reference. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param projectParameters The input projection parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#project Read more...} */ project(url: string, projectParameters: ProjectParameters, requestOptions?: RequestOptions): Promise; /** * Computes the set of pairs of geometries from the input geometry arrays that belong to the specified relation. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param relationParameters The set of parameters required to perform the comparison. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#relation Read more...} */ relation(url: string, relationParameters: RelationParameters, requestOptions?: RequestOptions): Promise; /** * The reshape operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometry The Polyline or Polygon to be reshaped. * @param reshaper The single-part polyline that performs the reshaping. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#reshape Read more...} */ reshape(url: string, geometry: GeometryUnion, reshaper: Polyline, requestOptions?: RequestOptions): Promise; /** * Alters the given geometries to make their definitions topologically legal with respect to their geometry type. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries The geometries to simplify. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#simplify Read more...} */ simplify(url: string, geometries: GeometryUnion[], requestOptions?: RequestOptions): Promise; /** * Converts an array of XY-coordinates into well-known strings based on the conversion type and spatial * reference supplied by the user. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param params See the object specifications table below for the structure of the `params` object. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#toGeoCoordinateString Read more...} */ toGeoCoordinateString(url: string, params: geometryServiceToGeoCoordinateStringParams, requestOptions?: RequestOptions): Promise; /** * Trims or extends the input polylines using the user specified guide polyline. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param trimExtendParameters Input parameters for the `trimExtend` operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#trimExtend Read more...} */ trimExtend(url: string, trimExtendParameters: TrimExtendParameters, requestOptions?: RequestOptions): Promise; /** * The union operation is performed on a geometry service resource. * * @param url The GeoScene Server REST service URL of a GeometryService. * @param geometries An array of the geometries to be unioned. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#union Read more...} */ union(url: string, geometries: GeometryUnion[], requestOptions?: RequestOptions): Promise; } export const geometryService: geometryService; export interface geometryServiceFromGeoCoordinateStringParams { strings: string[]; sr?: SpatialReference | string | number; conversionType?: "mrgs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd"; conversionMode?: string; } export interface geometryServiceToGeoCoordinateStringParams { sr: SpatialReference | string | number; coordinates: number[][]; conversionType: "mgrs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd"; conversionMode?: string; numOfDigits?: number; rounding?: boolean; addSpaces?: boolean; } /** * Represents a GP resource exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor.html Read more...} */ interface geoprocessor { /** * Sends a request to the server to execute a synchronous GP task. * * @param url URL to the GeoScene Server REST resource that represents a Geoprocessing service. * @param params * Specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters: * * `` Input_Points * * `` Distance * * * The `params` argument would then be an Object of the form: * ``` * { * Input_Points: , * Distance: * } * * ``` * @param options * specifies the input options for the geoprocessing service return values. The `options` argument could be an Object of the form: * ``` * { * returnZ: true * } * * ``` * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor.html#execute Read more...} */ execute(url: string, params?: any, options?: GPOptions, requestOptions?: RequestOptions): Promise; /** * Submits a job to the server for asynchronous processing by the GP task. * * @param url URL to the GeoScene Server REST resource that represents a Geoprocessing service. * @param params * specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters: * * `` Input_Points * * `` Distance * * * The `params` argument would then be an Object of the form: * ``` * { * Input_Points: , * Distance: * } * * ``` * @param options * specifies the input options for the geoprocessing service return values. The `options` argument could be an Object of the form: * ``` * { * returnZ: true * } * * ``` * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor.html#submitJob Read more...} */ submitJob(url: string, params?: any, options?: GPOptions, requestOptions?: RequestOptions): Promise; } export const geoprocessor: geoprocessor; /** * A convenience module for providing input options for the geoprocessing service return values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor-GPOptions.html Read more...} */ interface GPOptions { outSpatialReference: SpatialReferenceProperties | nullish; processExtent: ExtentProperties | nullish; processSpatialReference: SpatialReferenceProperties | nullish; returnColumnName: boolean; returnFeatureCollection: boolean; returnM: boolean; returnZ: boolean; } export const GPOptions: GPOptions; /** * Performs an identify operation on the layers of a map service exposed by the GeoScene * Server REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-identify.html Read more...} */ interface identify { /** * Sends a request to the GeoScene REST map service resource to identify features based on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html IdentifyParameters} specified. * * @param url URL to the GeoScene Server REST resource that represents a map service. * @param params Specifies the criteria used to identify the features. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-identify.html#identify Read more...} */ identify(url: string, params: IdentifyParameters, requestOptions?: RequestOptions): Promise; } export const identify: identify; /** * Performs various operations on an image service resource:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html Read more...} */ interface imageService { /** * Computes the rotation angle of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} at a given location. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param parameters Specifies parameters for computing angles. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computeAngles Read more...} */ computeAngles(url: string, parameters: ImageAngleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes histograms based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param parameters Specifies parameters for computing histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computeHistograms Read more...} */ computeHistograms(url: string, parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Computes the corresponding pixel location in columns and rows for an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} based on input geometry. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param parameters Specifies parameters for computing image space pixel location. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computePixelSpaceLocations Read more...} */ computePixelSpaceLocations(url: string, parameters: ImagePixelLocationParameters, requestOptions?: RequestOptions): Promise; /** * Computes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterBandStatistics statistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#RasterHistogram histograms} * for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html ImageHistogramParameters}. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param parameters Specifies parameters for computing statistics and histograms. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computeStatisticsHistograms Read more...} */ computeStatisticsHistograms(url: string, parameters: ImageHistogramParametersProperties, requestOptions?: RequestOptions): Promise; /** * Finds images based on the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html FindImagesParameters}. * * @param url The url of the image service to perform the find images operation on. * @param parameters Specifies the find images parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#findImages Read more...} */ findImages(url: string, parameters: FindImagesParametersProperties, requestOptions?: RequestOptions): Promise; /** * Retrieves an image's url using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html ImageUrlParameters}. * * @param url The url of the image service to perform the get image url operation on. * @param parameters Specifies the image url parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#getImageUrl Read more...} */ getImageUrl(url: string, parameters: ImageUrlParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param parameters The parameters used in the getSamples operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#getSamples Read more...} */ getSamples(url: string, parameters: ImageSampleParametersProperties, requestOptions?: RequestOptions): Promise; /** * Sends a request to the GeoScene REST image service resource to identify content based on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html ImageIdentifyParameters} * specified in the `params` argument. * * @param url URL to the GeoScene Server REST resource that represents an image service. * @param params Specifies the criteria used to identify the features. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#identify Read more...} */ identify(url: string, params: ImageIdentifyParameters, requestOptions?: RequestOptions): Promise; /** * Convert a geometry from an image space to a map space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html ImageToMapParameters}. * * @param url The url of the image service to perform the image to map operation on. * @param parameters Specifies the image to map parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#imageToMap Read more...} */ imageToMap(url: string, parameters: ImageToMapParametersProperties, requestOptions?: RequestOptions): Promise; /** * Creates a map space geometry from multiray image space geometries using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html ImageToMapMultirayParameters}. * * @param url The url of the image service to perform the image to map multiray operation on. * @param parameters Specifies the image to map multiray parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#imageToMapMultiray Read more...} */ imageToMapMultiray(url: string, parameters: ImageToMapMultirayParametersProperties, requestOptions?: RequestOptions): Promise; /** * Converts a given geometry from a map space to an image space using the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html MapToImageParameters}. * * @param url The url of the image service to perform the map to image operation on. * @param parameters Specifies the map to image parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#mapToImage Read more...} */ mapToImage(url: string, parameters: MapToImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the area and perimeter of a given geometry on an image service. * * @param url The url of the image service to perform the area and perimeter measurement on. * @param parameters Specifies parameters for measuring the area and perimeter of a given geometry on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaAndPerimeter Read more...} */ measureAreaAndPerimeter(url: string, parameters: ImageAreaParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param url The url of the image service to perform the height measurement on. * @param parameters Specifies the parameters for measuring the area. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaFromImage Read more...} */ measureAreaFromImage(url: string, parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the distance and angle between two points on an image service. * * @param url The url of the image service to perform the distance and angle measurement on. * @param parameters Specifies parameters for measuring a distance and an angle on an image between two points. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureDistanceAndAngle Read more...} */ measureDistanceAndAngle(url: string, parameters: ImageDistanceParametersProperties, requestOptions?: RequestOptions): Promise; /** * Calculates the height of an object between two points on an image service. * * @param url The url of the image service to perform the height measurement on. * @param parameters Specifies the parameters for measuring the height of an object between two points on an image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureHeight Read more...} */ measureHeight(url: string, parameters: ImageHeightParametersProperties, requestOptions?: RequestOptions): Promise; /** * Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * * * Image service must be published from a mosaic dataset. * * @param url The url of the image service to perform the measurement on. * @param parameters Specifies parameters for measuring the length. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureLengthFromImage Read more...} */ measureLengthFromImage(url: string, parameters: MeasureFromImageParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the location for a given point or centroid of a given area on an image service. * * @param url The service url. * @param parameters Specifies parameters for determining a point location or a centroid of a given area on the image service. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measurePointOrCentroid Read more...} */ measurePointOrCentroid(url: string, parameters: ImagePointParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns the boundary of an image for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html ImageBoundaryParameters}. * * @param url The url of the image service to query the boundary for. * @param parameters Specifies the imagery boundary parameters. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryBoundary Read more...} */ queryBoundary(url: string, parameters: ImageBoundaryParametersProperties, requestOptions?: RequestOptions): Promise; /** * Returns GPS information for the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html ImageGPSInfoParameters}. * * @param url The url of the image service to query GPS information from. * @param parameters Specifies the parameters for query GPS info operation. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryGPSInfo Read more...} */ queryGPSInfo(url: string, parameters: ImageGPSInfoParametersProperties, requestOptions?: RequestOptions): Promise; } export const imageService: imageService; export interface DataModel extends Accessor, JSONSupport { } export class DataModel { /** * Indicates if the data in the graph is managed by GeoScene Knowledge. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#arcgisManaged Read more...} */ readonly arcgisManaged: boolean; /** * A list of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} contained in the knowledge graph including their associated properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#entityTypes Read more...} */ readonly entityTypes: EntityType[]; /** * Information about the global ID for the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#identifierInfo Read more...} */ readonly identifierInfo: DataModelIdentifierInfo; /** * A list of the meta entity types in the knowledge graph and their associated properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#metaEntityTypes Read more...} */ readonly metaEntityTypes: EntityType[]; /** * A list of the provenance source type values and their behaviors in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#provenanceSourceTypeValues Read more...} */ readonly provenanceSourceTypeValues: SourceTypeValueBehavior[]; /** * A list of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} in the knowledge graph including their associated properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#relationshipTypes Read more...} */ readonly relationshipTypes: RelationshipType[]; /** * List of the search indexes in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#searchIndexes Read more...} */ readonly searchIndexes: SearchIndex[]; /** * Specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html spatial reference} information for the knowledge graph. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference | nullish; /** * Indicates whether users can make changes to the data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#strict Read more...} */ readonly strict: boolean | nullish; /** * The date the data model was last updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#timestamp Read more...} */ readonly timestamp: Date; /** * The data model defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} in a * knowledge graph service as well as some additional settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html Read more...} */ constructor(properties?: DataModelProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DataModel; } interface DataModelProperties { } export interface DataModelIdentifierInfo { identifierMappingInfo: DataModelIdentifierInfoIdentifierMappingInfo; identifierGenerationInfo: DataModelIdentifierInfoIdentifierGenerationInfo; } export interface DataModelIdentifierInfoIdentifierGenerationInfo { uuidMethodHint: "esriMethodHintUNSPECIFIED" | "esriUUIDESRI" | "esriUUIDRFC4122"; } export interface DataModelIdentifierInfoIdentifierMappingInfo { identifierInfoType: | "esriIdentifierInfoTypeUNSPECIFIED" | "esriIdentifierInfoTypeUniformProperty" | "esriIdentifierInfoTypeDatabaseNative"; databaseNativeIdentifier: any; uniformPropertyIdentifier: DataModelIdentifierInfoIdentifierMappingInfoUniformPropertyIdentifier; } export interface DataModelIdentifierInfoIdentifierMappingInfoUniformPropertyIdentifier { identifierPropertyName: string; } export class Entity extends GraphNamedObject { /** * An entity is a specific instance of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html EntityType} that can exist in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} with a common set of properties and a spatial feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#ascending Read more...} */ ascending: boolean; /** * Description of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#description Read more...} */ readonly description: string; /** * The ordered field names included in this index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#fieldNames Read more...} */ fieldNames: string[]; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#name Read more...} */ name: string; /** * Specifies if the values in the field are unique (no duplicate values). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#unique Read more...} */ unique: boolean; /** * Defines an index on fields associated with an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html Read more...} */ constructor(properties?: FieldIndexProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FieldIndex; } interface FieldIndexProperties { /** * Specifies if the field is indexed in ascending order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#ascending Read more...} */ ascending?: boolean; /** * The ordered field names included in this index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#fieldNames Read more...} */ fieldNames?: string[]; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#name Read more...} */ name?: string; /** * Specifies if the values in the field are unique (no duplicate values). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html#unique Read more...} */ unique?: boolean; } export class GraphAddFieldIndexResult extends GraphDataModelOperationResult { /** * Results returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddGraphFieldIndex adding a new field index} to a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddFieldIndexResult.html Read more...} */ constructor(properties?: GraphAddFieldIndexResultProperties); } interface GraphAddFieldIndexResultProperties extends GraphDataModelOperationResultProperties { } export class GraphAddNamedTypesResult extends GraphDataModelOperationResult { /** * Information specific to each added entity type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#entityAddResults Read more...} */ entityAddResults: AddResultsObject[]; /** * The number of entity types added to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#entityAddResultsCount Read more...} */ entityAddResultsCount: number; /** * Information specific to each added relationship type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#relationshipAddResults Read more...} */ relationshipAddResults: AddResultsObject[]; /** * The number of relationship types added to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#relationshipAddResultsCount Read more...} */ relationshipAddResultsCount: number; /** * The result returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddNamedTypes adding} a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} to a knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html Read more...} */ constructor(properties?: GraphAddNamedTypesResultProperties); } interface GraphAddNamedTypesResultProperties extends GraphDataModelOperationResultProperties { /** * Information specific to each added entity type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#entityAddResults Read more...} */ entityAddResults?: AddResultsObject[]; /** * The number of entity types added to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#entityAddResultsCount Read more...} */ entityAddResultsCount?: number; /** * Information specific to each added relationship type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#relationshipAddResults Read more...} */ relationshipAddResults?: AddResultsObject[]; /** * The number of relationship types added to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#relationshipAddResultsCount Read more...} */ relationshipAddResultsCount?: number; } /** * Information about the success of adding a new entity type or relationship type to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddNamedTypesResult.html#AddResultsObject Read more...} */ export interface AddResultsObject { name: string; error?: Error | nullish; } export class GraphAddPropertyResult extends GraphDataModelOperationResult { /** * Result returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddGraphProperties adding graph properties} to an entity type or relationship type in a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphAddPropertyResult.html Read more...} */ constructor(properties?: GraphAddPropertyResultProperties); } interface GraphAddPropertyResultProperties extends GraphDataModelOperationResultProperties { } export class GraphApplyEdits extends Accessor { /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityAdds Read more...} */ entityAdds: Entity[] | nullish; /** * A list of objects containing an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} and * the ids of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} of that type to delete. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityDeletes Read more...} */ entityDeletes: GraphNamedObjectDeletes[] | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} with the modified properties * to update in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityUpdates Read more...} */ entityUpdates: Entity[] | nullish; /** * Additional options to set an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html input quantization} for any geometries being added to the graph * and to automatically delete all relationships associated with a deleted entity. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#options Read more...} */ options: GraphApplyEditsOptions | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipAdds Read more...} */ relationshipAdds: knowledgeGraphRelationship[] | nullish; /** * A list of objects containing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}, and * the ids of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} of that type to delete. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipDeletes Read more...} */ relationshipDeletes: GraphNamedObjectDeletes[] | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} with modified properties * to update in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipUpdates Read more...} */ relationshipUpdates: knowledgeGraphRelationship[] | nullish; /** * This class defines {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to add, delete, and update in a knowledge graph service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html Read more...} */ constructor(properties?: GraphApplyEditsProperties); } interface GraphApplyEditsProperties { /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityAdds Read more...} */ entityAdds?: Entity[] | nullish; /** * A list of objects containing an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} and * the ids of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} of that type to delete. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityDeletes Read more...} */ entityDeletes?: GraphNamedObjectDeletes[] | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} with the modified properties * to update in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#entityUpdates Read more...} */ entityUpdates?: Entity[] | nullish; /** * Additional options to set an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html input quantization} for any geometries being added to the graph * and to automatically delete all relationships associated with a deleted entity. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#options Read more...} */ options?: GraphApplyEditsOptions | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipAdds Read more...} */ relationshipAdds?: knowledgeGraphRelationship[] | nullish; /** * A list of objects containing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}, and * the ids of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} of that type to delete. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipDeletes Read more...} */ relationshipDeletes?: GraphNamedObjectDeletes[] | nullish; /** * A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} with modified properties * to update in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#relationshipUpdates Read more...} */ relationshipUpdates?: knowledgeGraphRelationship[] | nullish; } export interface GraphApplyEditsOptions { inputQuantizationParameters?: InputQuantizationParameters; cascadeDelete?: boolean; cascadeProvenanceDelete?: boolean; } /** * GraphNamedObjectDeletes represents the list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html GraphNamedObjects} ({@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships}) of a specific type that will be deleted from a knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEdits.html#GraphNamedObjectDeletes Read more...} */ export interface GraphNamedObjectDeletes { typeName: string; ids: string[]; } export class GraphApplyEditsResult extends Accessor { /** * Returns a list of the Provenance entities that were deleted as a result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} * call with the `cascadeProvenanceDeletes` option enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#cascadeProvenanceDeleteResults Read more...} */ cascadeProvenanceDeleteResults: CascadeProvenanceDeleteResults[]; /** * Returns a list of objects for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} * that was deleted by as a result of deleting its origin or destination entity during an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} * call with the `cascadeDeletes` option enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#cascadeRelationshipDeleteResults Read more...} */ cascadeRelationshipDeleteResults: CascadeRelationshipDeleteResults[]; /** * Returns a list of objects for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} that added, updated or deleted records by * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#editResults Read more...} */ editResults: EditResultsObject[]; /** * The error message explaining information about why {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} failed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#error Read more...} */ error: Error | nullish; /** * If `true` there was an error processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#hasError Read more...} */ hasError: boolean; /** * The result of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} performed on a knowledge graph service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html Read more...} */ constructor(properties?: GraphApplyEditsResultProperties); } interface GraphApplyEditsResultProperties { /** * Returns a list of the Provenance entities that were deleted as a result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} * call with the `cascadeProvenanceDeletes` option enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#cascadeProvenanceDeleteResults Read more...} */ cascadeProvenanceDeleteResults?: CascadeProvenanceDeleteResults[]; /** * Returns a list of objects for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} * that was deleted by as a result of deleting its origin or destination entity during an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} * call with the `cascadeDeletes` option enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#cascadeRelationshipDeleteResults Read more...} */ cascadeRelationshipDeleteResults?: CascadeRelationshipDeleteResults[]; /** * Returns a list of objects for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} that added, updated or deleted records by * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#editResults Read more...} */ editResults?: EditResultsObject[]; /** * The error message explaining information about why {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()} failed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#error Read more...} */ error?: Error | nullish; /** * If `true` there was an error processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits executeApplyEdits()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#hasError Read more...} */ hasError?: boolean; } /** * CascadeProvenanceDeleteResults contains the `id` of the Provenance {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html GraphNamedObject} * that was deleted from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph} as well as any errors that occurred during the operation, * when edits were applied with `cascadeProvenanceDelete` set to true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#CascadeProvenanceDeleteResults Read more...} */ export interface CascadeProvenanceDeleteResults { id: string; error?: Error; } /** * cascadeRelationshipDeletesResults returns a list of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} of each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html type} * that were deleted from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph} due to one of their endpoints being deleted, as well as any errors that occurred during the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#CascadeRelationshipDeleteResults Read more...} */ export interface CascadeRelationshipDeleteResults { typeName: string; cascadeRelationshipDeletes: NamedObjectCascadeRelationshipDeleteResults[]; } /** * editResultsObject returns a list of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} of each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html type} * that was added, updated or deleted from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph} as well as any errors that occurred during the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#editResultsObject Read more...} */ export interface EditResultsObject { typeName: string; adds: NamedObjectEditResults[]; updates: NamedObjectEditResults[]; deletes: NamedObjectEditResults[]; } /** * NamedObjectCascadeRelationshipDeleteResults contains the `id` of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html Relationship} that * was deleted from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph} along with its origin id, destination id and error information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectCascadeRelationshipDeleteResults Read more...} */ export interface NamedObjectCascadeRelationshipDeleteResults { id: string; originId: string; destinationId: string; error?: Error; } /** * NamedObjectEditResults contains the `id` of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html GraphNamedObject} * ({@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html Entity} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html Relationship}) that * was added, updated or deleted from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph} as well as any errors that occurred during the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphApplyEditsResult.html#NamedObjectEditResults Read more...} */ export interface NamedObjectEditResults { id: string; error?: Error; } export class GraphDataModelOperationResult extends Accessor { /** * Any errors encountered while decoding the results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#decoderError Read more...} */ decoderError: Error | nullish; /** * Information about the add, update or delete modifications made to the data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#results Read more...} */ results: ResultsObject[]; /** * The number of modifications made to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#resultsCount Read more...} */ resultsCount: number; /** * The updated knowledge graph with the applied additions, updates, and deletions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#updatedKnowledgeGraph Read more...} */ updatedKnowledgeGraph: KnowledgeGraph | nullish; /** * The result returned after modifying a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html Read more...} */ constructor(properties?: GraphDataModelOperationResultProperties); } interface GraphDataModelOperationResultProperties { /** * Any errors encountered while decoding the results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#decoderError Read more...} */ decoderError?: Error | nullish; /** * Information about the add, update or delete modifications made to the data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#results Read more...} */ results?: ResultsObject[]; /** * The number of modifications made to the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#resultsCount Read more...} */ resultsCount?: number; /** * The updated knowledge graph with the applied additions, updates, and deletions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDataModelOperationResult.html#updatedKnowledgeGraph Read more...} */ updatedKnowledgeGraph?: KnowledgeGraph | nullish; } export interface ResultsObject { name: string; error?: Error | nullish; } export class GraphDeleteFieldIndexResult extends GraphDataModelOperationResult { /** * Result returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeDeleteGraphFieldIndex deleting a field index} from a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDeleteFieldIndexResult.html Read more...} */ constructor(properties?: GraphDeleteFieldIndexResultProperties); } interface GraphDeleteFieldIndexResultProperties extends GraphDataModelOperationResultProperties { } export class GraphDeleteNamedTypeResult extends GraphDataModelOperationResult { /** * The result returned when deleting an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} from a knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDeleteNamedTypeResult.html Read more...} */ constructor(properties?: GraphDeleteNamedTypeResultProperties); } interface GraphDeleteNamedTypeResultProperties extends GraphDataModelOperationResultProperties { } export class GraphDeletePropertyResult extends GraphDataModelOperationResult { /** * Result of deleting graph properties from an entity type or relationship type in a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphDeletePropertyResult.html Read more...} */ constructor(properties?: GraphDeletePropertyResultProperties); } interface GraphDeletePropertyResultProperties extends GraphDataModelOperationResultProperties { } export class GraphNamedObject extends GraphObject { /** * The unique ID of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#id Read more...} */ id: string; /** * Specifies the name for all similar types of objects ({@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships}) defined in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName Read more...} */ typeName: string; /** * The parent class for an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html Entity} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html Relationship} that is defined in the graph schema. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html Read more...} */ constructor(properties?: GraphNamedObjectProperties); static fromJSON(json: any): GraphNamedObject; } interface GraphNamedObjectProperties extends GraphObjectProperties { /** * The unique ID of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#id Read more...} */ id?: string; /** * Specifies the name for all similar types of objects ({@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships}) defined in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName Read more...} */ typeName?: string; } export interface GraphObject extends Accessor, JSONSupport { } export class GraphObject { /** * The properties of the graph object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObject.html#properties Read more...} */ properties: any | nullish; /** * This is the parent class of all objects that can be represented on a graph structure or graph query - {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html Entity}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html Relationship}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html Path}, and anonymous object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObject.html Read more...} */ constructor(properties?: GraphObjectProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObject.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObject.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GraphObject; } interface GraphObjectProperties { /** * The properties of the graph object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObject.html#properties Read more...} */ properties?: any | nullish; } export interface GraphObjectType extends Accessor, JSONSupport { } export class GraphObjectType { /** * The display name of the graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#alias Read more...} */ alias: string | nullish; /** * The name of the graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#name Read more...} */ name: string; /** * The object type's role in the knowledge graph. * * @default "Regular" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#role Read more...} */ role: "Regular" | "Provenance" | "Document"; /** * Parent object for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} defined in the graph schema. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html Read more...} */ constructor(properties?: GraphObjectTypeProperties); /** * Specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html index fields} for a graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#fieldIndexes Read more...} */ get fieldIndexes(): FieldIndex[]; set fieldIndexes(value: FieldIndexProperties[]); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html properties} of a graph object type such as an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html EntityType} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html RelationshipType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#properties Read more...} */ get properties(): GraphProperty[]; set properties(value: GraphPropertyProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GraphObjectType; } interface GraphObjectTypeProperties { /** * The display name of the graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#alias Read more...} */ alias?: string | nullish; /** * Specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html index fields} for a graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#fieldIndexes Read more...} */ fieldIndexes?: FieldIndexProperties[]; /** * The name of the graph object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#name Read more...} */ name?: string; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html properties} of a graph object type such as an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html EntityType} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html RelationshipType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#properties Read more...} */ properties?: GraphPropertyProperties[]; /** * The object type's role in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphObjectType.html#role Read more...} */ role?: "Regular" | "Provenance" | "Document"; } export interface GraphProperty extends Accessor, JSONSupport { } export class GraphProperty { /** * The display name for the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#alias Read more...} */ alias: string | nullish; /** * Specifies a default value for the object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#defaultValue Read more...} */ defaultValue: any | nullish; /** * Specifies whether the property is visible by default. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#defaultVisibility Read more...} */ defaultVisibility: boolean; /** * Specifies whether the property is editable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#editable Read more...} */ editable: boolean; /** * Specifies the field type for the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#fieldType Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#geometryType Read more...} */ geometryType: string | nullish; /** * Specifies whether the property has an m-value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#hasM Read more...} */ hasM: boolean | nullish; /** * Specifies whether property has a z-value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#hasZ Read more...} */ hasZ: boolean | nullish; /** * The name of the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#name Read more...} */ name: string; /** * Specifies whether the property can be `null`. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#nullable Read more...} */ nullable: boolean | nullish; /** * Specifies whether the property is required. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#required Read more...} */ required: boolean; /** * Specifies the role of the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#role Read more...} */ role: | "esriGraphPropertyUNSPECIFIED" | "esriGraphPropertyRegular" | "esriGraphPropertyDocumentName" | "esriGraphPropertyDocumentTitle" | "esriGraphPropertyDocumentUrl" | "esriGraphPropertyDocumentText" | "esriGraphPropertyDocumentKeywords" | "esriGraphPropertyDocumentContentType" | "esriGraphPropertyDocumentMetadata" | "esriGraphPropertyDocumentFileExtension" | "esriGraphPropertyProvenanceInstanceId" | "esriGraphPropertyProvenanceSourceType" | "esriGraphPropertyProvenanceSourceName" | "esriGraphPropertyProvenanceSource" | "esriGraphPropertyProvenanceComment" | "esriGraphPropertyProvenanceTypeName" | "esriGraphPropertyProvenancePropertyName"; /** * Specifies if the property is system maintained. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#systemMaintained Read more...} */ systemMaintained: boolean | nullish; /** * Specifies the properties for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} defined in the graph schema by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html data model}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html Read more...} */ constructor(properties?: GraphPropertyProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GraphProperty; } interface GraphPropertyProperties { /** * The display name for the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#alias Read more...} */ alias?: string | nullish; /** * Specifies a default value for the object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#defaultValue Read more...} */ defaultValue?: any | nullish; /** * Specifies whether the property is visible by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#defaultVisibility Read more...} */ defaultVisibility?: boolean; /** * Specifies whether the property is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#editable Read more...} */ editable?: boolean; /** * Specifies the field type for the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#fieldType Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#geometryType Read more...} */ geometryType?: string | nullish; /** * Specifies whether the property has an m-value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#hasM Read more...} */ hasM?: boolean | nullish; /** * Specifies whether property has a z-value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#hasZ Read more...} */ hasZ?: boolean | nullish; /** * The name of the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#name Read more...} */ name?: string; /** * Specifies whether the property can be `null`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#nullable Read more...} */ nullable?: boolean | nullish; /** * Specifies whether the property is required. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#required Read more...} */ required?: boolean; /** * Specifies the role of the property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#role Read more...} */ role?: | "esriGraphPropertyUNSPECIFIED" | "esriGraphPropertyRegular" | "esriGraphPropertyDocumentName" | "esriGraphPropertyDocumentTitle" | "esriGraphPropertyDocumentUrl" | "esriGraphPropertyDocumentText" | "esriGraphPropertyDocumentKeywords" | "esriGraphPropertyDocumentContentType" | "esriGraphPropertyDocumentMetadata" | "esriGraphPropertyDocumentFileExtension" | "esriGraphPropertyProvenanceInstanceId" | "esriGraphPropertyProvenanceSourceType" | "esriGraphPropertyProvenanceSourceName" | "esriGraphPropertyProvenanceSource" | "esriGraphPropertyProvenanceComment" | "esriGraphPropertyProvenanceTypeName" | "esriGraphPropertyProvenancePropertyName"; /** * Specifies if the property is system maintained. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html#systemMaintained Read more...} */ systemMaintained?: boolean | nullish; } export class GraphQuery extends Accessor { /** * The GeoScene implementation of [openCypher](https://opencypher.org/) query to be executed against the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQuery.html#openCypherQuery Read more...} */ openCypherQuery: string; /** * Defines the query operation performed on a knowledge graph service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQuery.html Read more...} */ constructor(properties?: GraphQueryProperties); } interface GraphQueryProperties { /** * The GeoScene implementation of [openCypher](https://opencypher.org/) query to be executed against the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQuery.html#openCypherQuery Read more...} */ openCypherQuery?: string; } export class GraphQueryResult extends Accessor { /** * An array of the result types that are returned from a search or query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryResult.html#resultRows Read more...} */ resultRows: GraphAnyValue[][]; /** * The results of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQuery executeQuery()} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearch executeSearch()} on a knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryResult.html Read more...} */ constructor(properties?: GraphQueryResultProperties); } interface GraphQueryResultProperties { /** * An array of the result types that are returned from a search or query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryResult.html#resultRows Read more...} */ resultRows?: GraphAnyValue[][]; } export type GraphAnyValue = Path | GraphObject | GeometryUnion | Date | string | number | nullish | GraphAnyValue[]; export class GraphQueryResultHeader extends Accessor { exceededTransferLimit: boolean; headerKeys: string[]; outSpatialReference: any | nullish; constructor(properties?: GraphQueryResultHeaderProperties); } interface GraphQueryResultHeaderProperties { exceededTransferLimit?: boolean; headerKeys?: string[]; outSpatialReference?: any | nullish; } export class GraphQueryStreaming extends GraphQuery { /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#bindGeometryQuantizationParameters Read more...} */ bindGeometryQuantizationParameters: InputQuantizationParameters | nullish; /** * Specifies a set of parameters containing data to be included in the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#bindParameters Read more...} */ bindParameters: | HashMap< | HashMap | number | bigint | string | Date | GeometryUnion | (HashMap | number | string | Date | GeometryUnion)[] > | nullish; /** * Used to project the geometry onto a virtual grid, likely representing * pixels on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#outputQuantizationParameters Read more...} */ outputQuantizationParameters: OutputQuantizationParameters | nullish; /** * Enables provenance to be used and returned in the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#provenanceBehavior Read more...} */ provenanceBehavior: "exclude" | "include" | nullish; /** * Defines a streaming query operation performed on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html Read more...} */ constructor(properties?: GraphQueryStreamingProperties); /** * Custom output spatial reference parameters for output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#outputSpatialReference Read more...} */ get outputSpatialReference(): SpatialReference | nullish; set outputSpatialReference(value: SpatialReferenceProperties | nullish); } interface GraphQueryStreamingProperties extends GraphQueryProperties { /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#bindGeometryQuantizationParameters Read more...} */ bindGeometryQuantizationParameters?: InputQuantizationParameters | nullish; /** * Specifies a set of parameters containing data to be included in the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#bindParameters Read more...} */ bindParameters?: | HashMap< | HashMap | number | bigint | string | Date | GeometryUnion | (HashMap | number | string | Date | GeometryUnion)[] > | nullish; /** * Used to project the geometry onto a virtual grid, likely representing * pixels on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#outputQuantizationParameters Read more...} */ outputQuantizationParameters?: OutputQuantizationParameters | nullish; /** * Custom output spatial reference parameters for output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#outputSpatialReference Read more...} */ outputSpatialReference?: SpatialReferenceProperties | nullish; /** * Enables provenance to be used and returned in the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html#provenanceBehavior Read more...} */ provenanceBehavior?: "exclude" | "include" | nullish; } export class GraphQueryStreamingResult extends Accessor { /** * Readable stream of objects matching {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearchStreaming executeSearchStreaming()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQueryStreaming executeQueryStreaming()} criteria. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreamingResult.html#resultRowsStream Read more...} */ resultRowsStream: any; /** * The result of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearchStreaming executeSearchStreaming()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQueryStreaming executeQueryStreaming()} on a knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreamingResult.html Read more...} */ constructor(properties?: GraphQueryStreamingResultProperties); } interface GraphQueryStreamingResultProperties { /** * Readable stream of objects matching {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearchStreaming executeSearchStreaming()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQueryStreaming executeQueryStreaming()} criteria. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreamingResult.html#resultRowsStream Read more...} */ resultRowsStream?: any; } export class GraphSearch extends Accessor { /** * The text to search for in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html#searchQuery Read more...} */ searchQuery: string; /** * Specifies whether to search {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entities}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationships}, or both. * * @default "both" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html#typeCategoryFilter Read more...} */ typeCategoryFilter: "entity" | "relationship" | "both"; /** * The search operation is performed on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html Read more...} */ constructor(properties?: GraphSearchProperties); } interface GraphSearchProperties { /** * The text to search for in the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html#searchQuery Read more...} */ searchQuery?: string; /** * Specifies whether to search {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entities}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationships}, or both. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html#typeCategoryFilter Read more...} */ typeCategoryFilter?: "entity" | "relationship" | "both"; } export class GraphSearchStreaming extends GraphSearch { /** * Specifies list of IDs to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#idsFilter Read more...} */ idsFilter: string[] | nullish; /** * Specifies list of names of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html#name entity types} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html#name relationship types} to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#namedTypesFilter Read more...} */ namedTypesFilter: string[] | nullish; /** * The maximum number of results returned from the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#num Read more...} */ num: number | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#returnSearchContext Read more...} */ returnSearchContext: boolean; /** * The index of the first result to return. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#start Read more...} */ start: number | nullish; /** * The search operation is performed on a knowledge graph service's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html Read more...} */ constructor(properties?: GraphSearchStreamingProperties); } interface GraphSearchStreamingProperties extends GraphSearchProperties { /** * Specifies list of IDs to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#idsFilter Read more...} */ idsFilter?: string[] | nullish; /** * Specifies list of names of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html#name entity types} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html#name relationship types} to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#namedTypesFilter Read more...} */ namedTypesFilter?: string[] | nullish; /** * The maximum number of results returned from the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#num Read more...} */ num?: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#returnSearchContext Read more...} */ returnSearchContext?: boolean; /** * The index of the first result to return. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html#start Read more...} */ start?: number | nullish; } export class GraphUpdateNamedTypesResult extends GraphDataModelOperationResult { /** * Result returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateNamedType updating} an entity type or relationship type in a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphUpdateNamedTypesResult.html Read more...} */ constructor(properties?: GraphUpdateNamedTypesResultProperties); } interface GraphUpdateNamedTypesResultProperties extends GraphDataModelOperationResultProperties { } export class GraphUpdatePropertyResult extends GraphDataModelOperationResult { /** * Result returned after {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateGraphProperty updating a graph property} on an entity type or relationship type in a knowledge graph data model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphUpdatePropertyResult.html Read more...} */ constructor(properties?: GraphUpdatePropertyResultProperties); } interface GraphUpdatePropertyResultProperties extends GraphDataModelOperationResultProperties { } export class GraphUpdateSearchIndexResult extends GraphDataModelOperationResult { /** * Result returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateSearchIndex updating the search index} for a knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphUpdateSearchIndexResult.html Read more...} */ constructor(properties?: GraphUpdateSearchIndexResultProperties); } interface GraphUpdateSearchIndexResultProperties extends GraphDataModelOperationResultProperties { } export class InputQuantizationParameters extends Accessor { /** * Origin of M-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#mFalseOrigin Read more...} */ mFalseOrigin: number | nullish; /** * Number of significant digits for M-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#mResolution Read more...} */ mResolution: number | nullish; /** * False origin of x values of the quantization grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#xFalseOrigin Read more...} */ xFalseOrigin: number | nullish; /** * Number of significant digits for the x and y coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#xyResolution Read more...} */ xyResolution: number | nullish; /** * False origin for y-values of the quantization grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#yFalseOrigin Read more...} */ yFalseOrigin: number | nullish; /** * The false origin of the Z-values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#zFalseOrigin Read more...} */ zFalseOrigin: number | nullish; /** * Number of significant digits of the Z-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#zResolution Read more...} */ zResolution: number | nullish; /** * Custom quantization parameters for input geometry that compresses geometry for transfer to the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html Read more...} */ constructor(properties?: InputQuantizationParametersProperties); } interface InputQuantizationParametersProperties { /** * Origin of M-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#mFalseOrigin Read more...} */ mFalseOrigin?: number | nullish; /** * Number of significant digits for M-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#mResolution Read more...} */ mResolution?: number | nullish; /** * False origin of x values of the quantization grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#xFalseOrigin Read more...} */ xFalseOrigin?: number | nullish; /** * Number of significant digits for the x and y coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#xyResolution Read more...} */ xyResolution?: number | nullish; /** * False origin for y-values of the quantization grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#yFalseOrigin Read more...} */ yFalseOrigin?: number | nullish; /** * The false origin of the Z-values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#zFalseOrigin Read more...} */ zFalseOrigin?: number | nullish; /** * Number of significant digits of the Z-Values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-InputQuantizationParameters.html#zResolution Read more...} */ zResolution?: number | nullish; } export interface KnowledgeGraph extends Accessor, JSONSupport { } export class KnowledgeGraph { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html data model} of the knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#dataModel Read more...} */ readonly dataModel: DataModel; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html service definition} of the knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#serviceDefinition Read more...} */ readonly serviceDefinition: ServiceDefinition; /** * The url to a hosted knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#url Read more...} */ url: string; /** * The knowledge graph associated with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledgeGraphService}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html Read more...} */ constructor(properties?: KnowledgeGraphProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): KnowledgeGraph; } interface KnowledgeGraphProperties { /** * The url to a hosted knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html#url Read more...} */ url?: string; } export class OutputQuantizationParameters extends Accessor { /** * An extent defining the quantization grid bounds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#extent Read more...} */ extent: OutputQuantizationParametersExtent | nullish; /** * Geometry coordinates are optimized for viewing and displaying of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#quantizeMode Read more...} */ quantizeMode: "view" | "edit" | nullish; /** * The size of one pixel in the units of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#tolerance Read more...} */ tolerance: number | nullish; /** * Used to project the geometry onto a virtual grid, likely representing * pixels on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html Read more...} */ constructor(properties?: OutputQuantizationParametersProperties); } interface OutputQuantizationParametersProperties { /** * An extent defining the quantization grid bounds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#extent Read more...} */ extent?: OutputQuantizationParametersExtent | nullish; /** * Geometry coordinates are optimized for viewing and displaying of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#quantizeMode Read more...} */ quantizeMode?: "view" | "edit" | nullish; /** * The size of one pixel in the units of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-OutputQuantizationParameters.html#tolerance Read more...} */ tolerance?: number | nullish; } export interface OutputQuantizationParametersExtent { xmax: number; xmin: number; ymax: number; ymin: number; } export interface Path extends Accessor, JSONSupport { } export class Path { /** * An object containing all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} * required to traverse a graph from one entity to another. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html Read more...} */ constructor(properties?: PathProperties); /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html#path Read more...} */ get path(): GraphNamedObject[]; set path(value: GraphNamedObjectProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Path; } interface PathProperties { /** * Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Path.html#path Read more...} */ path?: GraphNamedObjectProperties[]; } export class knowledgeGraphRelationship extends GraphNamedObject { /** * The ID of the destination entity of the relationship (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html#destinationId Read more...} */ destinationId: string; /** * The ID of the origin entity of the relationship (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html#originId Read more...} */ originId: string; /** * A relationship is an instance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} that defines an association between two {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html Read more...} */ constructor(properties?: knowledgeGraphRelationshipProperties); static fromJSON(json: any): knowledgeGraphRelationship; } interface knowledgeGraphRelationshipProperties extends GraphNamedObjectProperties { /** * The ID of the destination entity of the relationship (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html#destinationId Read more...} */ destinationId?: string; /** * The ID of the origin entity of the relationship (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html#originId Read more...} */ originId?: string; } export class RelationshipType extends GraphObjectType { /** * Specifies valid origin and destination {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} pairs for this relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html#endPoints Read more...} */ endPoints: RelationshipTypeEndPoints[]; /** * A relationship type defines a homogenous collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} that can exist between two {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types}, * with a common set of properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html Read more...} */ constructor(properties?: RelationshipTypeProperties); static fromJSON(json: any): RelationshipType; } interface RelationshipTypeProperties extends GraphObjectTypeProperties { /** * Specifies valid origin and destination {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} pairs for this relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html#endPoints Read more...} */ endPoints?: RelationshipTypeEndPoints[]; } export interface RelationshipTypeEndPoints { originEntityType: string; destinationEntityType: string; } export class SearchIndex extends Accessor { /** * Additional analyzers for string processing during search such as support for languages. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html#analyzers Read more...} */ readonly analyzers: SearchIndexAnalyzers[]; /** * The name of the search index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html#name Read more...} */ readonly name: string; /** * A map of the named types and their properties that are included in the search index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html#searchProperties Read more...} */ readonly searchProperties: globalThis.Map; /** * Specifies if the index supports searching provenance, entities, relationships or both. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html#supportedCategory Read more...} */ readonly supportedCategory: | "esriTypeUNSPECIFIED" | "esriTypeEntity" | "esriTypeRelationship" | "esriTypeBoth" | "esriTypeMetaEntityProvenance"; /** * Defines a search index for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html KnowledgeGraph}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html Read more...} */ constructor(properties?: SearchIndexProperties); } interface SearchIndexProperties { } export interface SearchIndexAnalyzers { name: string; } /** * Search properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html#SearchProperties Read more...} */ export interface SearchIndexSearchProperties { propertyNames: string[]; } export interface ServiceDefinition extends Accessor, JSONSupport { } export class ServiceDefinition { /** * Indicates if geometry data in the graph can be modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#allowGeometryUpdates Read more...} */ readonly allowGeometryUpdates: boolean; /** * Specifies the operational capabilities of the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#capabilities Read more...} */ readonly capabilities: string[]; /** * Copyright information for the knowledge graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#copyrightText Read more...} */ readonly copyrightText: string; /** * The version number of the GeoScene Enterprise instance where the knowledge graph service is hosted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#currentVersion Read more...} */ readonly currentVersion: number | nullish; /** * Indicates if data editing is not supported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#dataEditingNotSupported Read more...} */ readonly dataEditingNotSupported: boolean; /** * Specifies the timezone for dateTime fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#dateFieldsTimeReference Read more...} */ readonly dateFieldsTimeReference: ServiceDefinitionDateFieldsTimeReference | nullish; /** * The description of the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#description Read more...} */ readonly description: string; /** * The maximum number of records returned by a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQuery query} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#maxRecordCount Read more...} */ readonly maxRecordCount: number | nullish; /** * Indicates if the knowledge graph schema (data model) can be edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#schemaEditingNotSupported Read more...} */ readonly schemaEditingNotSupported: boolean; /** * The maximum number of records returned by a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearch search} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#searchMaxRecordCount Read more...} */ readonly searchMaxRecordCount: number | nullish; /** * specifies the details of the index, edit, search and geometry capabilities of the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#serviceCapabilities Read more...} */ readonly serviceCapabilities: ServiceDefinitionServiceCapabilities; /** * The GeoScene Enterprise Portal item id of the knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#serviceItemId Read more...} */ readonly serviceItemId: string; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} information for the knowledge graph service. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#spatialReference Read more...} */ readonly spatialReference: SpatialReference | nullish; /** * The query formats supported by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#supportedQueryFormats Read more...} */ readonly supportedQueryFormats: string[]; /** * Indicates if the service supports entity types with a document role. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#supportsDocuments Read more...} */ readonly supportsDocuments: boolean; /** * Indicates if the service supports provenance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#supportsProvenance Read more...} */ readonly supportsProvenance: boolean; /** * Indicates if the services supports search operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#supportsSearch Read more...} */ readonly supportsSearch: boolean; /** * The units for the spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#units Read more...} */ readonly units: string; /** * Outlines the service capabilities for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledgeGraphService}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html Read more...} */ constructor(properties?: ServiceDefinitionProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-ServiceDefinition.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ServiceDefinition; } interface ServiceDefinitionProperties { } export interface ServiceDefinitionDateFieldsTimeReference { respectsDaylightSaving: boolean; timeZone: string; } export interface ServiceDefinitionServiceCapabilities { indexCapabilities: ServiceDefinitionServiceCapabilitiesIndexCapabilities; applyEditsCapabilities: ServiceDefinitionServiceCapabilitiesApplyEditsCapabilities; searchCapabilities: ServiceDefinitionServiceCapabilitiesSearchCapabilities; geometryCapabilities: ServiceDefinitionServiceCapabilitiesGeometryCapabilities; } export interface ServiceDefinitionServiceCapabilitiesApplyEditsCapabilities { graphDefaultRollbackOnFailure: boolean; } export interface ServiceDefinitionServiceCapabilitiesGeometryCapabilities { geometryMaxBoundingRectangleSizeX: number; geometryMaxBoundingRectangleSizeY: number; supportsMValues: boolean; supportsZValues: boolean; supportedGeometryTypes: string[]; } export interface ServiceDefinitionServiceCapabilitiesIndexCapabilities { supportsDescendingIndex: boolean; supportsUniqueRelationshipConstraint: boolean; supportsRelationshipIndex: boolean; } export interface ServiceDefinitionServiceCapabilitiesSearchCapabilities { searchTypeFilterCapabilities: ("esriTypeEntity" | "esriTypeRelationship" | "esriTypeBoth")[]; allowLeadingWildcardQueries: boolean; } export interface SourceTypeValueBehavior extends Accessor, JSONSupport { } export class SourceTypeValueBehavior { /** * Specifies the behavior from ('URL', 'String', or 'Document') of the source type value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SourceTypeValueBehavior.html#behavior Read more...} */ readonly behavior: string | nullish; /** * Specifies the source type value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SourceTypeValueBehavior.html#value Read more...} */ readonly value: string | nullish; /** * An entity type defines a homogeneous collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} with a common set of properties and a spatial feature type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SourceTypeValueBehavior.html Read more...} */ constructor(properties?: SourceTypeValueBehaviorProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SourceTypeValueBehavior.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SourceTypeValueBehavior.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SourceTypeValueBehavior; } interface SourceTypeValueBehaviorProperties { } export interface CIMFilteredFindPathsConfiguration extends Accessor, JSONSupport { } export class CIMFilteredFindPathsConfiguration { /** * Specifies the direction which the algorithm uses to traverse relationship in the path. * * @default "Any" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#defaultTraversalDirectionType Read more...} */ defaultTraversalDirectionType: "Any" | "Forward" | "Backward"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the destination of the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities Read more...} */ destinationEntities: CIMFilteredFindPathsEntity[]; /** * Specifies how the origin and destination entities are used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} algorithm. * * @default "AnyOriginAnyDestination" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#entityUsage Read more...} */ entityUsage: | "AnyOriginAnyDestination" | "AnyOriginAllDestinations" | "AllOriginsAnyDestination" | "AllOriginsAllDestinations" | "EachPair"; /** * The maximum number of paths that the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} * algorithm returns. * * @default 100000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxCountPaths Read more...} */ maxCountPaths: number; /** * The maximum path length. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxPathLength Read more...} */ maxPathLength: number; /** * The minimum path length. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#minPathLength Read more...} */ minPathLength: number; /** * The name of the configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#name Read more...} */ name: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the origin of the paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities Read more...} */ originEntities: CIMFilteredFindPathsEntity[]; /** * Any {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html filters} to use during pathfinding. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathFilters Read more...} */ pathFilters: CIMFilteredFindPathsPathFilter[]; /** * Specifies whether the filtered find paths algorithm searches for all paths or only the shortest paths. * * @default "Shortest" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathMode Read more...} */ pathMode: "Shortest" | "All"; /** * The filtered find paths algorithm uses traversal directions to specify how relationships are traversed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#traversalDirections Read more...} */ traversalDirections: CIMKGTraversalDirection[]; readonly type: "CIMFilteredFindPathsConfiguration"; /** * The pathfinding configuration for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html Read more...} */ constructor(properties?: CIMFilteredFindPathsConfigurationProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CIMFilteredFindPathsConfiguration; } interface CIMFilteredFindPathsConfigurationProperties { /** * Specifies the direction which the algorithm uses to traverse relationship in the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#defaultTraversalDirectionType Read more...} */ defaultTraversalDirectionType?: "Any" | "Forward" | "Backward"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the destination of the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities Read more...} */ destinationEntities?: CIMFilteredFindPathsEntity[]; /** * Specifies how the origin and destination entities are used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} algorithm. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#entityUsage Read more...} */ entityUsage?: | "AnyOriginAnyDestination" | "AnyOriginAllDestinations" | "AllOriginsAnyDestination" | "AllOriginsAllDestinations" | "EachPair"; /** * The maximum number of paths that the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} * algorithm returns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxCountPaths Read more...} */ maxCountPaths?: number; /** * The maximum path length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#maxPathLength Read more...} */ maxPathLength?: number; /** * The minimum path length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#minPathLength Read more...} */ minPathLength?: number; /** * The name of the configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#name Read more...} */ name?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html entities} to use as the origin of the paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities Read more...} */ originEntities?: CIMFilteredFindPathsEntity[]; /** * Any {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html filters} to use during pathfinding. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathFilters Read more...} */ pathFilters?: CIMFilteredFindPathsPathFilter[]; /** * Specifies whether the filtered find paths algorithm searches for all paths or only the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathMode Read more...} */ pathMode?: "Shortest" | "All"; /** * The filtered find paths algorithm uses traversal directions to specify how relationships are traversed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#traversalDirections Read more...} */ traversalDirections?: CIMKGTraversalDirection[]; } export interface CIMFilteredFindPathsEntity extends Accessor, JSONSupport { } export class CIMFilteredFindPathsEntity { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#entityTypeName Read more...} */ entityTypeName: string | nullish; /** * The unique ID to use as a filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD Read more...} */ iD: string | nullish; /** * The property filter predicate (openCypher syntax) associated with the path filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#propertyFilterPredicate Read more...} */ propertyFilterPredicate: string | nullish; readonly type: "CIMFilteredFindPathsEntity"; /** * Defines an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities origin} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities destination} entity, * in this case the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD} is used, or all entities of an entity type, in which case the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD} is null. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html Read more...} */ constructor(properties?: CIMFilteredFindPathsEntityProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CIMFilteredFindPathsEntity; } interface CIMFilteredFindPathsEntityProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD iD}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#entityTypeName Read more...} */ entityTypeName?: string | nullish; /** * The unique ID to use as a filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#iD Read more...} */ iD?: string | nullish; /** * The property filter predicate (openCypher syntax) associated with the path filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsEntity.html#propertyFilterPredicate Read more...} */ propertyFilterPredicate?: string | nullish; } export interface CIMFilteredFindPathsPathFilter extends Accessor, JSONSupport { } export class CIMFilteredFindPathsPathFilter { /** * Specifies the filter type to use in the path filter for the specified entity or relationship. * * @default "Exclude" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#filterType Read more...} */ filterType: "IncludeOnly" | "Exclude" | "MandatoryWaypoint" | "OptionalWaypoint"; /** * The unique ID to use as a filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD Read more...} */ iD: string | nullish; /** * Whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName itemTypeName} is an entity or relationship. * * @default "Entity" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemType Read more...} */ itemType: "Entity" | "Relationship"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity or relationship specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName Read more...} */ itemTypeName: string | nullish; /** * The property filter predicate (openCypher syntax) associated with the path filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#propertyFilterPredicate Read more...} */ propertyFilterPredicate: string | nullish; readonly type: "CIMFilteredFindPathsPathFilter"; /** * Defines path filters to determine what records are used to find paths in the graph between the * origin * and destination entities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html Read more...} */ constructor(properties?: CIMFilteredFindPathsPathFilterProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CIMFilteredFindPathsPathFilter; } interface CIMFilteredFindPathsPathFilterProperties { /** * Specifies the filter type to use in the path filter for the specified entity or relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#filterType Read more...} */ filterType?: "IncludeOnly" | "Exclude" | "MandatoryWaypoint" | "OptionalWaypoint"; /** * The unique ID to use as a filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD Read more...} */ iD?: string | nullish; /** * Whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName itemTypeName} is an entity or relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemType Read more...} */ itemType?: "Entity" | "Relationship"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphNamedObject.html#typeName typeName} of the entity or relationship specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD iD}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#itemTypeName Read more...} */ itemTypeName?: string | nullish; /** * The property filter predicate (openCypher syntax) associated with the path filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#propertyFilterPredicate Read more...} */ propertyFilterPredicate?: string | nullish; } export interface CIMKGTraversalDirection extends Accessor, JSONSupport { } export class CIMKGTraversalDirection { /** * Specifies the direction which the algorithm uses to traverse relationships in the path. * * @default "Any" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#traversalDirectionType Read more...} */ traversalDirectionType: "Any" | "Forward" | "Backward"; readonly type: "CIMKGTraversalDirection"; /** * The traversal directions * that specify how relationships are traversed along paths between the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities origin} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities destination}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html Read more...} */ constructor(properties?: CIMKGTraversalDirectionProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CIMKGTraversalDirection; } interface CIMKGTraversalDirectionProperties { /** * Specifies the direction which the algorithm uses to traverse relationships in the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-CIMKGTraversalDirection.html#traversalDirectionType Read more...} */ traversalDirectionType?: "Any" | "Forward" | "Backward"; } export class FindPathsToolSettings extends Accessor { /** * The pathfinding configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#config Read more...} */ config: CIMFilteredFindPathsConfiguration; /** * URL to the [GeoScene Knowledge Server REST](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm) resource that represents a knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#inKnowledgeGraphUrl Read more...} */ inKnowledgeGraphUrl: string; /** * Settings for executing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html Read more...} */ constructor(properties?: FindPathsToolSettingsProperties); } interface FindPathsToolSettingsProperties { /** * The pathfinding configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#config Read more...} */ config?: CIMFilteredFindPathsConfiguration; /** * URL to the [GeoScene Knowledge Server REST](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm) resource that represents a knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html#inKnowledgeGraphUrl Read more...} */ inKnowledgeGraphUrl?: string; } /** * A knowledge graph service is associated with several resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html Read more...} */ interface knowledgeGraphService { /** * Adds a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html field index} for a particular property on an * entity type or relationship type in a graph. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type with the property for which to add a field index. * @param fieldIndexes The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html field indexes} to add. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddGraphFieldIndex Read more...} */ executeAddGraphFieldIndex(graph: KnowledgeGraph, namedType: string, fieldIndexes: FieldIndex[], options: RequestOptions): Promise; /** * Add a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html GraphProperty} for a particular entity type or relationship type. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type to update with the property to be updated. * @param namedTypeProperties A list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html graph properties} to add to the entity type or relationship type. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddGraphProperties Read more...} */ executeAddGraphProperties(graph: KnowledgeGraph, namedType: string, namedTypeProperties: GraphProperty[], options?: RequestOptions): Promise; /** * Create new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} in your knowledge graph. * * @param graph The knowledge graph. Retrieved using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#fetchKnowledgeGraph `fetchKnowledgeGraph()`}. * @param namedTypes The new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity types} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship types} to add to the graph. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeAddNamedTypes Read more...} */ executeAddNamedTypes(graph: KnowledgeGraph, namedTypes: knowledgeGraphServiceExecuteAddNamedTypesNamedTypes, options?: RequestOptions): Promise; /** * Add, delete, or update {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param edits Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Entity.html entities} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-Relationship.html relationships} and their properties to add, update or delete. * @param requestOptions Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeApplyEdits Read more...} */ executeApplyEdits(graph: KnowledgeGraph, edits: GraphApplyEdits, requestOptions?: RequestOptions): Promise; /** * Deletes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html field index} for a particular property on an * entity type or relationship type in a graph. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type to update. * @param fieldIndexNames The names of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-FieldIndex.html field index} to delete. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeDeleteGraphFieldIndex Read more...} */ executeDeleteGraphFieldIndex(graph: KnowledgeGraph, namedType: string, fieldIndexNames: string[], options: RequestOptions): Promise; /** * Delete a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html GraphProperty} for a particular entity type or relationship type. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type to update with the property to be updated. * @param propertyName The name of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html GraphProperty} to delete. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeDeleteGraphProperty Read more...} */ executeDeleteGraphProperty(graph: KnowledgeGraph, namedType: string, propertyName: string, options?: RequestOptions): Promise; /** * Delete an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} from the graph. * * @param graph The knowledge graph. Retrieved using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#fetchKnowledgeGraph `fetchKnowledgeGraph()`}. * @param namedType The name of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type} to delete. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeDeleteNamedType Read more...} */ executeDeleteNamedType(graph: KnowledgeGraph, namedType: string, options?: RequestOptions): Promise; /** * Executes a request to the ServerFilteredFindPaths GP tool. * * @param toolSettings The pathfinding configuration such as origin and destination, waypoints and other tool settings. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html FindPathToolSettings} for the full list of available settings. * @param requestOptions Additional options specified in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths Read more...} */ executeFindPaths(toolSettings: FindPathsToolSettings, requestOptions?: RequestOptions): Promise; /** * Executes an asynchronous request to the ServerFilteredFindPaths GP tool. * * @param toolSettings The pathfinding configuration such as origin and destination, waypoints and other tool settings. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-toolService-findPaths-FindPathsToolSettings.html FindPathToolSettings} for the full list of available settings. * @param requestOptions The options specified by the user in the data request. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#RequestOptions RequestOptions} for available properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous Read more...} */ executeFindPathsAsynchronous(toolSettings: FindPathsToolSettings, requestOptions?: RequestOptions): Promise; /** * Executes a query on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource using the GeoScene implementation of [openCypher](https://opencypher.org/) and returns the results. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param queryArguments Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQuery.html query} to perform on the provided knowledge graph service. * @param requestOptions Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQuery Read more...} */ executeQuery(graph: KnowledgeGraph, queryArguments: GraphQuery, requestOptions?: RequestOptions): Promise; /** * Execute a streaming query on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param queryArguments Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphQueryStreaming.html query} to perform on the provided knowledge graph service. Optionally specify additional query parameters * @param requestOptions Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeQueryStreaming Read more...} */ 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. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param searchArguments Defines the free text {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearch.html search} to run against a knowledge graph. * @param requestOptions Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearch Read more...} */ executeSearch(graph: KnowledgeGraph, searchArguments: GraphSearch, requestOptions?: RequestOptions): Promise; /** * Execute a streaming search on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html knowledge graph service's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html graph} resource. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param searchArguments Define the free text {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphSearchStreaming.html search} to execute against the knowledge graph. Optionally specify additional search parameters. * @param requestOptions Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeSearchStreaming Read more...} */ executeSearchStreaming(graph: KnowledgeGraph, searchArguments: GraphSearchStreaming, requestOptions?: RequestOptions): Promise; /** * Update a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html GraphProperty} for a particular entity type or relationship type in the graph. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type to update with the property to be updated. * @param originalPropertyName The original name of the property to update. * @param updatedProperties The updated properties for the entity type or relationship type property specified. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateGraphProperty Read more...} */ executeUpdateGraphProperty(graph: KnowledgeGraph, namedType: string, originalPropertyName: string, updatedProperties: UpdateGraphProperties, options?: RequestOptions): Promise; /** * Update an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-EntityType.html entity type} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-RelationshipType.html relationship type}. * * @param graph The knowledge graph to update. * @param namedType The name of the entity type or relationship type to update with the property to be updated. * @param updatedNamedType The updated entity type or relationship type. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateNamedType Read more...} */ executeUpdateNamedType(graph: KnowledgeGraph, namedType: string, updatedNamedType: UpdateNamedType, options?: RequestOptions): Promise; /** * Update the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-SearchIndex.html search index} used by the knowledge graph. * * @param graph The knowledge graph to update. * @param namedType The name of the entity or relationship type to update. * @param searchProperties The properties of the named type with which to update the search index. * @param options Additional options to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateSearchIndex Read more...} */ executeUpdateSearchIndex(graph: KnowledgeGraph, namedType: string, searchProperties: knowledgeGraphServiceExecuteUpdateSearchIndexSearchProperties, options?: RequestOptions): Promise; /** * Retrieves the filtered find path results from a job started by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * * @param jobInfo The job info returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * @param requestOptions Additional options specified in the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#fetchAsynchronousFindPathsResultData Read more...} */ fetchAsynchronousFindPathsResultData(jobInfo: JobInfo, requestOptions?: RequestOptions): Promise; /** * Retrieves the specified client data keys from the knowledge graph service associated with the given knowledge graph, if they exist. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * @param keysToFetch An array of client data keys to fetch from the service * @param options Additional options when requesting client keys. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#fetchClientDataAtKeys Read more...} */ fetchClientDataAtKeys(graph: KnowledgeGraph, keysToFetch: string[], options?: knowledgeGraphServiceFetchClientDataAtKeysOptions): Promise>; /** * Retrieves the knowledge graph service based on the URL provided. * * @param url URL to the [GeoScene Knowledge Server REST](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm) resource that represents a knowledge graph service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#fetchKnowledgeGraph Read more...} */ fetchKnowledgeGraph(url: string): Promise; /** * Refreshes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-DataModel.html data model} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph}. * * @param graph The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-KnowledgeGraph.html knowledge graph} associated with the service. See also [GeoScene REST APIs - Hosted Knowledge Graph Service](https://doc.geoscene.cn/rest/services-reference/enterprise/kgs-hosted-server.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#refreshDataModel Read more...} */ refreshDataModel(graph: KnowledgeGraph): void; } export const knowledgeGraphService: knowledgeGraphService; /** * Errors returned in the result of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#CIMFilteredFindPathsError Read more...} */ export interface CIMFilteredFindPathsError { type: "CIMFilteredFindPathsError"; error: | "None" | "ConfigurationHasTooManyInputEntities" | "ConfigurationIsTooComplex" | "PunctualEventHasNoTime" | "DurativeEventHasNoTime" | "DurativeEventHasOneMissingTime" | "DurativeEventHasSwappedTimes"; detailedErrorMessage: string; } /** * The returned result of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#CIMFilteredFindPathsResultJSON Read more...} */ export interface CIMFilteredFindPathsResultJSON { type: "CIMFilteredFindPathsResult"; error?: CIMFilteredFindPathsError; configurationWarning: | "None" | "AllOriginsAreExcluded" | "AllDestinationsAreExcluded" | "AllOptionalWaypointsAreExcluded" | "AtLeastOneMandatoryEntityWaypointIsExcluded" | "AtLeastOneMandatoryRelationshipWaypointIsExcluded" | "ReachedMaxPathLength"; statistics: CIMFilteredFindPathsStatistics; paths: CIMFilteredFindPathsResultPaths; } /** * Represents the paths found by an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#CIMFilteredFindPathsResultPaths Read more...} */ export interface CIMFilteredFindPathsResultPaths { type: "CIMKGPaths"; entitiesUIDs?: string[]; entityTypes?: number[]; indexedEntityTypes?: string[]; relationshipsGroupsUIDsBuffer?: string[]; relationshipTypes?: number[]; indexedRelationshipTypes?: string[]; relationshipsGroupsUIDsEndIndex?: number[]; relationshipsGroupsFrom?: number[]; relationshipsGroupsTo?: number[]; relationshipsFrom?: number[]; relationshipsTo?: number[]; pathsBuffer?: number[]; pathsEndIndex?: number[]; } /** * Represents the statistics related to an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPaths executeFindPaths} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeFindPathsAsynchronous executeFindPathsAsynchronous} search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#CIMFilteredFindPathsStatistics Read more...} */ export interface CIMFilteredFindPathsStatistics { type: "CIMFilteredFindPathsStatistics"; countLocalGraphNodes?: number; countLocalGraphEdges?: number; countOriginExpansionQueries?: number; countDestinationExpansionQueries?: number; countWaypointsExpansionQueries?: number; } export interface knowledgeGraphServiceExecuteAddNamedTypesNamedTypes { newEntityTypes: EntityType[]; newRelationshipTypes: RelationshipType[]; } export interface knowledgeGraphServiceExecuteUpdateSearchIndexSearchProperties { addSearchProperties: SearchIndexSearchProperties; removeSearchProperties: SearchIndexSearchProperties; } export interface knowledgeGraphServiceFetchClientDataAtKeysOptions { ignoreCache?: boolean; requestOptions?: RequestOptions; } /** * The properties of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraph-GraphProperty.html GraphProperty} that can be updated with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#executeUpdateGraphProperty `executeUpdateGraphProperty`}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#UpdateGraphProperties Read more...} */ export interface UpdateGraphProperties { alias?: string; editable?: boolean; required?: boolean; defaultVisibility?: boolean; defaultValue?: any; } /** * Properties of a named type that can be updated, such as the `alias`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-knowledgeGraphService.html#UpdateNamedType Read more...} */ export interface UpdateNamedType { alias?: string; } /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator} functions when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html Read more...} */ interface locator { /** * Find address candidates for multiple input addresses. * * @param url URL to the GeoScene Server REST resource that represents a locator service. * @param params See specifications below. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#addressesToLocations Read more...} */ addressesToLocations(url: string, params: locatorAddressesToLocationsParams, requestOptions?: RequestOptions): Promise; /** * Sends a request to the GeoScene REST geocode resource to find candidates for a single address specified in the address parameter. * * @param url URL to the GeoScene Server REST resource that represents a locator service. * @param params Specify at least the `address` and optionally other properties. See the object specifications table below. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#addressToLocations Read more...} */ addressToLocations(url: string, params: locatorAddressToLocationsParams, requestOptions?: RequestOptions): Promise; /** * Locates an address based on a given point. * * @param url URL to the GeoScene Server REST resource that represents a locator service. * @param params Specify at least the `location` and optionally the `locationType`. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#locationToAddress Read more...} */ locationToAddress(url: string, params: locatorLocationToAddressParams, requestOptions?: RequestOptions): Promise; /** * Get character by character auto complete suggestions. * * @param url URL to the GeoScene Server REST resource that represents a locator service. * @param params An object that defines suggest parameters. See specifications below. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#suggestLocations Read more...} */ suggestLocations(url: string, params: locatorSuggestLocationsParams, requestOptions?: RequestOptions): Promise; } export const locator: locator; export interface locatorAddressesToLocationsParams { addresses: any[]; countryCode?: string; categories?: string[]; locationType?: "rooftop" | "street" | nullish; outSpatialReference?: SpatialReference; } export interface locatorAddressToLocationsParams { address: any; categories?: string[]; countryCode?: string; forStorage?: boolean; location?: Point; locationType?: "rooftop" | "street" | nullish; magicKey?: string; maxLocations?: number; outFields?: string[]; outSpatialReference?: SpatialReference; searchExtent?: Extent; } export interface locatorLocationToAddressParams { location: Point; locationType?: "street" | "rooftop" | nullish; outSpatialReference?: SpatialReference; } export interface locatorSuggestLocationsParams { categories?: string[]; location: Point; text: string; } /** * Describes the object representing the result of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#suggestLocations suggestLocations()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#SuggestionResult Read more...} */ export interface SuggestionResult { isCollection: boolean | nullish; magicKey: string | nullish; text: string | nullish; } /** * The utility network associations model connectivity, containment, and structure relations between assets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-queryAssociations.html Read more...} */ interface queryAssociations { /** * Returns all associations filtered by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters} in a utility network. * * @param url URL to the GeoScene Server REST resource that represents a UttilityNetwork. * @param props The parameters required by this functions include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#elements elements}, what {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#types types} of associations to return, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#moment moment} and more. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-queryAssociations.html#queryAssociations Read more...} */ queryAssociations(url: string, props: QueryAssociationsParameters, requestOptions?: RequestOptions): Promise; } export const queryAssociations: queryAssociations; export interface AggregatedGeometry extends Accessor, JSONSupport { } export class AggregatedGeometry { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline} geometry representing a union of all polyline features encountered during the trace and specified by the output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html#line Read more...} */ readonly line: Polyline | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multi-point} 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html#multipoint Read more...} */ readonly multipoint: Multipoint | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} geometry representing a union of all polygon features encountered during the trace and specified by the output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html#polygon Read more...} */ readonly polygon: Polygon | nullish; /** * A class that defines an aggregation of geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html Read more...} */ constructor(properties?: AggregatedGeometryProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AggregatedGeometry; } interface AggregatedGeometryProperties { } export interface Association extends Accessor, JSONSupport { } export class Association { /** * The type of association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#associationType Read more...} */ associationType: string; /** * Error code returned from the server for a failed associations query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#errorCode Read more...} */ errorCode: number | nullish; /** * Message returned from the server for a failed associations query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#errorMessage Read more...} */ errorMessage: string | nullish; /** * The globalId (UUID) of the association record, uniquely identifies this association row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#globalId Read more...} */ globalId: string | nullish; /** * Specifies the content visibility on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#isContentVisible Read more...} */ isContentVisible: boolean | nullish; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#percentAlong Read more...} */ percentAlong: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#status Read more...} */ status: number | nullish; /** * The utility network associations model connectivity, containment and structure relations between assets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Read more...} */ constructor(properties?: AssociationProperties); /** * The from side network element of the association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#fromNetworkElement Read more...} */ get fromNetworkElement(): NetworkElement | nullish; set fromNetworkElement(value: NetworkElementProperties | nullish); /** * The synthesized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline} geometry created between the two network elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#geometry Read more...} */ get geometry(): Polyline; set geometry(value: PolylineProperties); /** * The to side network element of the association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#toNetworkElement Read more...} */ get toNetworkElement(): NetworkElement | nullish; set toNetworkElement(value: NetworkElementProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Association; } interface AssociationProperties { /** * The type of association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#associationType Read more...} */ associationType?: string; /** * Error code returned from the server for a failed associations query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#errorCode Read more...} */ errorCode?: number | nullish; /** * Message returned from the server for a failed associations query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#errorMessage Read more...} */ errorMessage?: string | nullish; /** * The from side network element of the association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#fromNetworkElement Read more...} */ fromNetworkElement?: NetworkElementProperties | nullish; /** * The synthesized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline} geometry created between the two network elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#geometry Read more...} */ geometry?: PolylineProperties; /** * The globalId (UUID) of the association record, uniquely identifies this association row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#globalId Read more...} */ globalId?: string | nullish; /** * Specifies the content visibility on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#isContentVisible Read more...} */ isContentVisible?: boolean | nullish; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#percentAlong Read more...} */ percentAlong?: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#status Read more...} */ status?: number | nullish; /** * The to side network element of the association. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html#toNetworkElement Read more...} */ toNetworkElement?: NetworkElementProperties | nullish; } export interface AssociationGeometriesResult extends Accessor, JSONSupport { } export class AssociationGeometriesResult { /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount maxGeometryCount} has exceeded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#maxGeometryCountExceeded Read more...} */ maxGeometryCountExceeded: boolean; /** * This class defines the results of the function {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-synthesizeAssociationGeometries.html synthesizeAssociationGeometries} which takes an extent and returns an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html AggregatedGeometry} of all * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} within the extent based on the defined parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html Read more...} */ constructor(properties?: AssociationGeometriesResultProperties); /** * List of returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} filtered based on the input parameters in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html SynthesizeAssociationGeometriesParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#associations Read more...} */ get associations(): Association[]; set associations(value: AssociationProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AssociationGeometriesResult; } interface AssociationGeometriesResultProperties { /** * List of returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} filtered based on the input parameters in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html SynthesizeAssociationGeometriesParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#associations Read more...} */ associations?: AssociationProperties[]; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount maxGeometryCount} has exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AssociationGeometriesResult.html#maxGeometryCountExceeded Read more...} */ maxGeometryCountExceeded?: boolean; } export interface FunctionResult extends Accessor, JSONSupport { } export class FunctionResult { /** * The aggregate function type used in the supplied trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html#functionType Read more...} */ readonly functionType: "add" | "subtract" | "average" | "count" | "min" | "max" | nullish; /** * The name of the function result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html#networkAttributeName Read more...} */ readonly networkAttributeName: string | nullish; /** * Actual result of the aggregate function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html#result Read more...} */ readonly result: number | nullish; /** * A trace can optionally return a aggregated function result if the trace configuration asked for it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html Read more...} */ constructor(properties?: FunctionResultProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-FunctionResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#assetGroupCode Read more...} */ assetGroupCode: number; /** * The asset type code discriminator this network element represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#assetTypeCode Read more...} */ assetTypeCode: number; /** * The globalId of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#globalId Read more...} */ globalId: string; /** * The network source Id of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#networkSourceId Read more...} */ networkSourceId: number; /** * The objectId of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#objectId Read more...} */ objectId: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element starts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#positionFrom Read more...} */ positionFrom: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element ends. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#positionTo Read more...} */ positionTo: number | nullish; /** * The terminal id defined at the network element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#terminalId Read more...} */ terminalId: number; /** * The network element is a representation of how the network topology defines its graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html Read more...} */ constructor(properties?: NetworkElementProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): NetworkElement; } interface NetworkElementProperties { /** * The asset group code that this network element represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#assetGroupCode Read more...} */ assetGroupCode?: number; /** * The asset type code discriminator this network element represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#assetTypeCode Read more...} */ assetTypeCode?: number; /** * The globalId of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#globalId Read more...} */ globalId?: string; /** * The network source Id of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#networkSourceId Read more...} */ networkSourceId?: number; /** * The objectId of the feature the network element belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#objectId Read more...} */ objectId?: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element starts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#positionFrom Read more...} */ positionFrom?: number; /** * Applicable to edge elements, represents a double value (0 to 1) where this edge element ends. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#positionTo Read more...} */ positionTo?: number | nullish; /** * The terminal id defined at the network element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html#terminalId Read more...} */ terminalId?: number; } export interface QueryAssociationsParameters extends Accessor, JSONSupport { } export class QueryAssociationsParameters { /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Specifies whether to return logically deleted associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#returnDeletes Read more...} */ returnDeletes: boolean; /** * Specifies an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} types to be queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#types Read more...} */ types: string[]; /** * QueryAssociationsParameters describes the parameters required to execute the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-queryAssociations.html queryAssociations()} function, which returns a list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} filtered by the parameters set. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html Read more...} */ constructor(properties?: QueryAssociationsParametersProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html NetworkElements} for which the association is queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#elements Read more...} */ get elements(): NetworkElement[]; set elements(value: NetworkElementProperties[]); /** * The date/timestamp (in UTC) to execute the function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#moment Read more...} */ get moment(): Date | nullish; set moment(value: DateProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): QueryAssociationsParameters; } interface QueryAssociationsParametersProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html NetworkElements} for which the association is queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#elements Read more...} */ elements?: NetworkElementProperties[]; /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The date/timestamp (in UTC) to execute the function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#moment Read more...} */ moment?: DateProperties | nullish; /** * Specifies whether to return logically deleted associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#returnDeletes Read more...} */ returnDeletes?: boolean; /** * Specifies an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} types to be queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html#types Read more...} */ types?: string[]; } export interface QueryAssociationsResult extends Accessor, JSONSupport { } export class QueryAssociationsResult { /** * Defines the results of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-queryAssociations.html queryAssociations()} function which takes in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters} and returns an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html QueryAssociationsResult} of all * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} filtered by the parameters set. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html Read more...} */ constructor(properties?: QueryAssociationsResultProperties); /** * List of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} returned filtered based on the input parameters in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html#associations Read more...} */ get associations(): Association[]; set associations(value: AssociationProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): QueryAssociationsResult; } interface QueryAssociationsResultProperties { /** * List of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html associations} returned filtered based on the input parameters in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsParameters.html QueryAssociationsParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-QueryAssociationsResult.html#associations Read more...} */ associations?: AssociationProperties[]; } export interface SynthesizeAssociationGeometriesParameters extends Accessor, JSONSupport { } export class SynthesizeAssociationGeometriesParameters { /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount Read more...} */ maxGeometryCount: number | nullish; /** * The spatial reference of the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#outSpatialReference Read more...} */ outSpatialReference: any | nullish; /** * Indicates whether to synthesize and return structural attachment associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnAttachmentAssociations Read more...} */ returnAttachmentAssociations: boolean; /** * Indicates whether to synthesize and return connectivity associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnConnectivityAssociations Read more...} */ returnConnectivityAssociations: boolean; /** * Indicates whether to synthesize and return containment associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnContainmentAssociations Read more...} */ returnContainmentAssociations: boolean; /** * This class describes the parameters required to execute the synthesizeAssociationGeometries function which synthesizes and returns the associations geometries in a given extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html Read more...} */ constructor(properties?: SynthesizeAssociationGeometriesParametersProperties); /** * The extent used to execute a spatial query to retrieve the associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * The date/timestamp (in UTC) to execute the function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#moment Read more...} */ get moment(): Date | nullish; set moment(value: DateProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SynthesizeAssociationGeometriesParameters; } interface SynthesizeAssociationGeometriesParametersProperties { /** * The extent used to execute a spatial query to retrieve the associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * A number that indicates the maximum associations that should be synthesized after which the operation should immediately return. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#maxGeometryCount Read more...} */ maxGeometryCount?: number | nullish; /** * The date/timestamp (in UTC) to execute the function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#moment Read more...} */ moment?: DateProperties | nullish; /** * The spatial reference of the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#outSpatialReference Read more...} */ outSpatialReference?: any | nullish; /** * Indicates whether to synthesize and return structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnAttachmentAssociations Read more...} */ returnAttachmentAssociations?: boolean; /** * Indicates whether to synthesize and return connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnConnectivityAssociations Read more...} */ returnConnectivityAssociations?: boolean; /** * Indicates whether to synthesize and return containment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-SynthesizeAssociationGeometriesParameters.html#returnContainmentAssociations Read more...} */ returnContainmentAssociations?: boolean; } export interface TraceLocation extends Accessor, JSONSupport { } export class TraceLocation { /** * The globalId (UUID) of the feature to start or stop the trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#globalId Read more...} */ globalId: string; /** * This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#isFilterBarrier Read more...} */ isFilterBarrier: boolean; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#percentAlong Read more...} */ percentAlong: number; /** * The terminal Id to place the starting location at. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#terminalId Read more...} */ terminalId: number; /** * The type of the trace location; `starting-point` defines where the trace should start and `barrier` defines where the trace should stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#type Read more...} */ type: "starting-point" | "barrier" | "stopping-point"; /** * To perform the trace analytic, users can optionally supply a list of locations in forms of globalIds (UUID) and terminals. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html Read more...} */ constructor(properties?: TraceLocationProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TraceLocation; } interface TraceLocationProperties { /** * The globalId (UUID) of the feature to start or stop the trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#globalId Read more...} */ globalId?: string; /** * This indicates whether this barrier starting location should be skipped (filtered) when a trace attempts to find upstream controllers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#isFilterBarrier Read more...} */ isFilterBarrier?: boolean; /** * This double parameter of value of 0-1 indicates a percentage along the line of where the trace location is placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#percentAlong Read more...} */ percentAlong?: number; /** * The terminal Id to place the starting location at. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#terminalId Read more...} */ terminalId?: number; /** * The type of the trace location; `starting-point` defines where the trace should start and `barrier` defines where the trace should stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceLocation.html#type Read more...} */ type?: "starting-point" | "barrier" | "stopping-point"; } export interface TraceParameters extends Accessor, JSONSupport { } export class TraceParameters { /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * The globalId (UUID) of the named trace configuration persisted in the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#namedTraceConfigurationGlobalId Read more...} */ namedTraceConfigurationGlobalId: string | nullish; /** * Parameter specifying the types of results to return after running a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#resultTypes Read more...} */ resultTypes: ResultTypeJSON[] | nullish; /** * Defines the properties of a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceConfiguration Read more...} */ traceConfiguration: UNTraceConfiguration | nullish; /** * The trace type defined in this trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceType Read more...} */ traceType: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | "path" | "circuit" | nullish; /** * The list of parameters that are needed to determine how the trace analytic will be executed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html Read more...} */ constructor(properties?: TraceParametersProperties); /** * The date/timestamp (in UTC) to execute the function at a given time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#moment Read more...} */ get moment(): Date | nullish; set moment(value: DateProperties | nullish); /** * The spatial reference that should be used to project the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html aggregated geometries} returned by the trace (if applicable). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * The list of starting points and barriers that will define where the trace starts and stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceLocations Read more...} */ get traceLocations(): TraceLocation[]; set traceLocations(value: TraceLocationProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TraceParameters; } interface TraceParametersProperties { /** * The geodatabase version to execute the function against. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The date/timestamp (in UTC) to execute the function at a given time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#moment Read more...} */ moment?: DateProperties | nullish; /** * The globalId (UUID) of the named trace configuration persisted in the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#namedTraceConfigurationGlobalId Read more...} */ namedTraceConfigurationGlobalId?: string | nullish; /** * The spatial reference that should be used to project the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-AggregatedGeometry.html aggregated geometries} returned by the trace (if applicable). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * Parameter specifying the types of results to return after running a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#resultTypes Read more...} */ resultTypes?: ResultTypeJSON[] | nullish; /** * Defines the properties of a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceConfiguration Read more...} */ traceConfiguration?: UNTraceConfiguration | nullish; /** * The list of starting points and barriers that will define where the trace starts and stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceLocations Read more...} */ traceLocations?: TraceLocationProperties[]; /** * The trace type defined in this trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#traceType Read more...} */ traceType?: | "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | "path" | "circuit" | nullish; } /** * ResultTypeJSON specifies the type of results to return after running a trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceParameters.html#ResultTypeJSON Read more...} */ export interface ResultTypeJSON { type: "elements" | "aggregatedGeometry" | "paths" | "circuits"; includeGeometry: boolean; includePropagatedValues: boolean; networkAttributeNames: string[]; diagramTemplateName: string; resultTypeFields: any[]; } export interface TraceResult extends Accessor, JSONSupport { } export class TraceResult { /** * This property defines an aggregation of geometries returned by the trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#aggregatedGeometry Read more...} */ readonly aggregatedGeometry: AggregatedGeometry | nullish; /** * An array of network elements returned by the trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#elements Read more...} */ readonly elements: NetworkElement[]; /** * Returns an array of function aggregation results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#globalFunctionResults Read more...} */ readonly globalFunctionResults: FunctionResult[]; /** * This parameter is specific to the K-Nearest Neighbors Algorithm, when the nearest filter is provided in the trace configuration. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#kFeaturesForKNNFound Read more...} */ readonly kFeaturesForKNNFound: boolean; /** * Returns `true` if the starting points in the network trace operation are ignored. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#startingPointsIgnored Read more...} */ readonly startingPointsIgnored: boolean; /** * Returns any warnings encountered by the trace operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#warnings Read more...} */ readonly warnings: string[] | nullish; /** * This class defines the collection of results returned from the trace function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html Read more...} */ constructor(properties?: TraceResultProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-TraceResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TraceResult; } interface TraceResultProperties { } export interface ValidateNetworkTopologyParameters extends Accessor, JSONSupport { } export class ValidateNetworkTopologyParameters { /** * Specifies the geodatabase version name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * The spatial reference of the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#outSpatialReference Read more...} */ outSpatialReference: any | nullish; /** * Specifies the GUID used to lock the version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#sessionID Read more...} */ sessionID: string | nullish; /** * Specifies the set of features and objects to validate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validationSet Read more...} */ validationSet: ValidationSetItemJSON[] | nullish; /** * Specifies the validation to perform. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validationType Read more...} */ validationType: "normal" | "rebuild" | "force-rebuild" | nullish; /** * ValidateNetworkTopologyParameters describes the optional and required parameters for validating a network topology. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html Read more...} */ constructor(properties?: ValidateNetworkTopologyParametersProperties); /** * Specifies the envelope of the area to validate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validateArea Read more...} */ get validateArea(): Extent; set validateArea(value: ExtentProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ValidateNetworkTopologyParameters; } interface ValidateNetworkTopologyParametersProperties { /** * Specifies the geodatabase version name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The spatial reference of the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#outSpatialReference Read more...} */ outSpatialReference?: any | nullish; /** * Specifies the GUID used to lock the version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#sessionID Read more...} */ sessionID?: string | nullish; /** * Specifies the envelope of the area to validate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validateArea Read more...} */ validateArea?: ExtentProperties; /** * Specifies the set of features and objects to validate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validationSet Read more...} */ validationSet?: ValidationSetItemJSON[] | nullish; /** * Specifies the validation to perform. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#validationType Read more...} */ validationType?: "normal" | "rebuild" | "force-rebuild" | nullish; } /** * ValidationSetItemJSON represents the set of features and objects to validate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyParameters.html#ValidationSetItemJSON Read more...} */ export interface ValidationSetItemJSON { sourceId: number; globalIds: string[]; } /** * Class that holds the returned object after running the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#validateTopology Network.validateTopology()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyResult.html Read more...} */ interface ValidateNetworkTopologyResult { discoveredSubnetworks: Subnetwork[] | nullish; exceededTransferLimit: boolean | nullish; fullUpdate: boolean; moment: Date | nullish; serviceEdits: ValidateServiceEdits[] | nullish; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-Network.html#validateTopology Network.validateTopology()} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyResult.html#Subnetwork Read more...} */ export interface Subnetwork { domain: string; tier: string; subnetwork: string; } /** * ValidateServiceEdits represents the layerId and editedFeatures. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-ValidateNetworkTopologyResult.html#ValidateServiceEdits Read more...} */ export interface ValidateServiceEdits { layerId: number; editedFeatures?: any; } /** * The utility network associations model connectivity, containment, and structure relations between assets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-synthesizeAssociationGeometries.html Read more...} */ interface synthesizeAssociationGeometries { /** * Given an extent, returns all associations within this extent and their synthesized geometries. * * @param url URL to the GeoScene Server REST resource that represents a UttilityNetwork. * @param params The parameters required by this functions include extent, what types of associations to return, spatial reference and more * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-synthesizeAssociationGeometries.html#synthesizeAssociationGeometries Read more...} */ synthesizeAssociationGeometries(url: string, params: SynthesizeAssociationGeometriesParameters, requestOptions?: RequestOptions): 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-trace.html Read more...} */ interface trace { /** * The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results. * * @param url URL to the GeoScene Server REST resource that represents a UttilityNetwork. * @param params The list of parameters required by the trace * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-trace.html#trace Read more...} */ trace(url: string, params: TraceParameters, requestOptions?: RequestOptions): Promise; } export const trace: trace; /** * This modules contains functions for working with network services. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networkService.html Read more...} */ interface networkService { /** * Retrieve a description of the network service. * * @param url URL to the GeoScene Server REST resource that represents a network analysis service. * @param apiKey An authorization string used to access a resource or service (see [API keys](/documentation/security-and-authentication/api-key-authentication/)). * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networkService.html#fetchServiceDescription Read more...} */ fetchServiceDescription(url: string, apiKey?: string | null, requestOptions?: any | null): Promise; } export const networkService: networkService; /** * The network service description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networkService.html#ServiceDescription Read more...} */ export interface ServiceDescription { currentVersion: number | nullish; defaultTravelMode: TravelMode | nullish; supportedTravelModes: TravelMode[] | nullish; } /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html Read more...} */ interface places { /** * Get place details, including name, address, description, and other attributes. * * @param params Defines the parameters of the place details request. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#fetchPlace Read more...} */ fetchPlace(params: FetchPlaceParameters, requestOptions?: RequestOptions): Promise; /** * A nearby search that finds places within a given radius of a location. * * @param params Defines the parameters of the query request. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesNearPoint Read more...} */ queryPlacesNearPoint(params: PlacesQueryParameters, requestOptions?: RequestOptions): Promise; /** * A search that finds places within a given extent. * * @param params Defines the parameters of the query request. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesWithinExtent Read more...} */ queryPlacesWithinExtent(params: PlacesQueryParameters, requestOptions?: RequestOptions): 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://doc.geoscene.cn/rest/services-reference/export-web-map-task.htm) * available with ArGIS Server 10.1 and later. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html Read more...} */ interface print { /** * Sends a request to the print service to create a printable static image of the map using the options specified in * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html PrintParameters}. * * @param url The URL of the REST endpoint of the Export Web Map Task. * @param params Defines the printing options. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html#execute Read more...} */ execute(url: string, params: PrintParameters, requestOptions?: RequestOptions): Promise; /** * Request the mode for the print request service. * * @param url The URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html#getMode Read more...} */ getMode(url: string): Promise; } export const print: print; /** * Represents the response of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html#execute execute()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html#PrintResponse Read more...} */ export interface PrintResponse { url: string | nullish; } /** * Executes different types of query operations on a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html Read more...} */ interface query { /** * Query information about attachments associated with features from a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layer} specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param attachmentQuery Specifies the attachment parameters for query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeAttachmentQuery Read more...} */ executeAttachmentQuery(url: string, attachmentQuery: AttachmentQueryProperties, requestOptions?: RequestOptions): Promise; /** * Gets a count of the number of features that satisfy the input query. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForCount Read more...} */ executeForCount(url: string, query: QueryProperties, requestOptions?: RequestOptions): Promise; /** * Gets the extent of the features that satisfy the input query. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForExtent Read more...} */ executeForExtent(url: string, query: QueryProperties, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * @param layerMetadata Additional query options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForIds Read more...} */ executeForIds(url: string, query: QueryProperties, requestOptions?: RequestOptions, layerMetadata?: queryExecuteForIdsLayerMetadata): Promise<(number | string)[]>; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns * the count of features or records that satisfy the query. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForTopCount Read more...} */ executeForTopCount(url: string, topFeaturesQuery: TopFeaturesQuery, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForTopExtents Read more...} */ executeForTopExtents(url: string, topFeaturesQuery: TopFeaturesQuery, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns an * array of Object IDs of features that satisfy the query. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeForTopIds Read more...} */ executeForTopIds(url: string, topFeaturesQuery: TopFeaturesQuery, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * @param layerMetadata Additional query options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeQueryJSON Read more...} */ executeQueryJSON(url: string, query: QueryProperties, requestOptions?: RequestOptions, layerMetadata?: queryExecuteQueryJSONLayerMetadata): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * @param layerMetadata Additional query options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeQueryPBF Read more...} */ executeQueryPBF(url: string, query: QueryProperties, requestOptions?: RequestOptions, layerMetadata?: queryExecuteQueryPBFLayerMetadata): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against the layer specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param query Specifies the attributes and spatial filter of the query. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * @param layerMetadata Additional query options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeQueryFGB Read more...} */ executeQueryFGB(url: string, query: QueryProperties, requestOptions?: RequestOptions, layerMetadata?: queryExecuteQueryFGBLayerMetadata): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html RelationshipQuery} against the layer or table specified in the url parameter. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param relationshipQuery Specifies relationship parameters for querying related features or records from a layer or a table. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeRelationshipQuery Read more...} */ executeRelationshipQuery(url: string, relationshipQuery: RelationshipQueryProperties, requestOptions?: RequestOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html TopFeaturesQuery} against a feature service and returns a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} once the promise resolves. * * @param url URL to the GeoScene Server REST resource that represents a feature layer (usually of a Feature Service Layer or Map Service Layer). * @param topFeaturesQuery Specifies the attributes, spatial, temporal, and top filter of the query. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter topFilter} parameter must be set. * @param outSpatialReference The desired output spatial reference. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeTopFeaturesQuery Read more...} */ executeTopFeaturesQuery(url: string, topFeaturesQuery: TopFeaturesQuery, outSpatialReference: SpatialReference, requestOptions?: RequestOptions): Promise; } export const query: query; export interface AttachmentInfo extends Accessor, JSONSupport { } export class AttachmentInfo { /** * The content type of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#contentType Read more...} */ contentType: string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#ExifInfo ExifInfo} for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#exifInfo Read more...} */ exifInfo: ExifInfo[] | nullish; /** * The global identifier for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#globalId Read more...} */ globalId: string; /** * The identifier for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#id Read more...} */ id: number; /** * Keywords used for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#keywords Read more...} */ keywords: string; /** * String value indicating the name of the file attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#name Read more...} */ name: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#OrientationInfo OrientationInfo} for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#orientationInfo Read more...} */ readonly orientationInfo: OrientationInfo; /** * The parent or the feature global id of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#parentGlobalId Read more...} */ parentGlobalId: string | nullish; /** * The parent or the feature object id of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#parentObjectId Read more...} */ parentObjectId: number | string | nullish; /** * The file size of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#size Read more...} */ size: number; /** * The URL of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#url Read more...} */ url: string | nullish; /** * The `AttachmentInfo` class returns information about attachments associated with a * feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html Read more...} */ constructor(properties?: AttachmentInfoProperties); /** * Creates a deep clone of the AttachmentInfo class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#clone Read more...} */ clone(): AttachmentInfo; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttachmentInfo; } interface AttachmentInfoProperties { /** * The content type of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#contentType Read more...} */ contentType?: string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#ExifInfo ExifInfo} for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#exifInfo Read more...} */ exifInfo?: ExifInfo[] | nullish; /** * The global identifier for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#globalId Read more...} */ globalId?: string; /** * The identifier for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#id Read more...} */ id?: number; /** * Keywords used for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#keywords Read more...} */ keywords?: string; /** * String value indicating the name of the file attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#name Read more...} */ name?: string; /** * The parent or the feature global id of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#parentGlobalId Read more...} */ parentGlobalId?: string | nullish; /** * The parent or the feature object id of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#parentObjectId Read more...} */ parentObjectId?: number | string | nullish; /** * The file size of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#size Read more...} */ size?: number; /** * The URL of the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#url Read more...} */ url?: string | nullish; } /** * An array of [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) information * for the attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#ExifInfo Read more...} */ export interface ExifInfo { name?: string; tags?: ExifInfoTags[]; } /** * An object containing properties specific to the orientation of an image attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#OrientationInfo Read more...} */ export interface OrientationInfo { id?: number; rotation?: number; mirrored?: boolean; } export interface ExifInfoTags { name: string; description: string; value: any; } export interface queryExecuteForIdsLayerMetadata { uniqueIdFields?: string[] | nullish; } export interface queryExecuteQueryJSONLayerMetadata { uniqueIdFields?: string[] | nullish; } export interface queryExecuteQueryPBFLayerMetadata { uniqueIdFields?: string[] | nullish; } export interface queryExecuteQueryFGBLayerMetadata { uniqueIdFields?: string[] | nullish; } /** * Find routes between two or more locations and optionally get driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html Read more...} */ interface route { /** * Solves the route against the route layer with the route parameters. * * @param url URL to the GeoScene Server REST resource that represents a network analysis service. * @param params Route parameters used as input to generate the route. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-serviceArea.html Read more...} */ interface serviceArea { /** * Determines the service area based on a set of parameters. * * @param url URL to the GeoScene Server REST resource that represents a network analysis service. * @param params The parameters needed to define the service area. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-serviceArea.html#solve Read more...} */ solve(url: string, params: ServiceAreaParameters, requestOptions?: any | null): Promise; } export const serviceArea: serviceArea; export interface AddressCandidate extends Accessor, JSONSupport { } export class AddressCandidate { /** * Address of the candidate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#address Read more...} */ address: string | nullish; /** * Name value pairs of field name and field value as defined in `outFields` * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#addressToLocations locator.addressToLocations()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#attributes Read more...} */ attributes: any | nullish; /** * Numeric score between `0` and `100` for geocode candidates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#score Read more...} */ score: number | nullish; /** * Represents the result of a geocode service operation as a list of address candidates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html Read more...} */ constructor(properties?: AddressCandidateProperties); /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} object representing the location of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#address address}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AddressCandidate; } interface AddressCandidateProperties { /** * Address of the candidate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#address Read more...} */ address?: string | nullish; /** * Name value pairs of field name and field value as defined in `outFields` * in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html#addressToLocations locator.addressToLocations()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#attributes Read more...} */ attributes?: any | nullish; /** * The minimum and maximum X and Y coordinates of a bounding box of the address candidate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} object representing the location of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#address address}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#location Read more...} */ location?: PointProperties | nullish; /** * Numeric score between `0` and `100` for geocode candidates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AddressCandidate.html#score Read more...} */ score?: number | nullish; } export class AlgorithmicColorRamp extends ColorRamp { /** * The algorithm used to generate the colors between the `fromColor` and `toColor`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#algorithm Read more...} */ algorithm: "cie-lab" | "lab-lch" | "hsv" | nullish; /** * A string value representing the color ramp type. * * @default "algorithmic" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#type Read more...} */ readonly type: "algorithmic"; /** * Creates a color ramp for use in a raster renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html Read more...} */ constructor(properties?: AlgorithmicColorRampProperties); /** * The first color in the color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#fromColor Read more...} */ get fromColor(): Color; set fromColor(value: ColorProperties); /** * The last color in the color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#toColor Read more...} */ get toColor(): Color; set toColor(value: ColorProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#clone Read more...} */ clone(): AlgorithmicColorRamp; static fromJSON(json: any): AlgorithmicColorRamp; } interface AlgorithmicColorRampProperties extends ColorRampProperties { /** * The algorithm used to generate the colors between the `fromColor` and `toColor`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#algorithm Read more...} */ algorithm?: "cie-lab" | "lab-lch" | "hsv" | nullish; /** * The first color in the color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#fromColor Read more...} */ fromColor?: ColorProperties; /** * The last color in the color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AlgorithmicColorRamp.html#toColor Read more...} */ toColor?: ColorProperties; } export interface ArealUnit extends Accessor, JSONSupport { } export class ArealUnit { /** * Specifies the numerical area. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#area Read more...} */ area: number; /** * Specifies the unit of area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#units Read more...} */ units: | "international-acres" | "us-acres" | "ares" | "hectares" | "square-centimeters" | "square-decimeters" | "square-international-feet" | "square-us-feet" | "square-international-inches" | "square-us-inches" | "square-kilometers" | "square-meters" | "square-international-miles" | "square-us-miles" | "square-millimeters" | "square-international-yards" | "square-us-yards" | "unknown" | nullish; /** * A geoprocessing object that contains area information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html Read more...} */ constructor(properties?: ArealUnitProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ArealUnit; } interface ArealUnitProperties { /** * Specifies the numerical area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#area Read more...} */ area?: number; /** * Specifies the unit of area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ArealUnit.html#units Read more...} */ units?: | "international-acres" | "us-acres" | "ares" | "hectares" | "square-centimeters" | "square-decimeters" | "square-international-feet" | "square-us-feet" | "square-international-inches" | "square-us-inches" | "square-kilometers" | "square-meters" | "square-international-miles" | "square-us-miles" | "square-millimeters" | "square-international-yards" | "square-us-yards" | "unknown" | nullish; } export interface AreasAndLengthsParameters extends Accessor, JSONSupport { } export class AreasAndLengthsParameters { /** * The area unit in which areas of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#areaUnit Read more...} */ areaUnit: | "acres" | "ares" | "hectares" | "square-miles" | "square-kilometers" | "square-meters" | "square-feet" | "square-yards" | nullish; /** * Defines the type of calculation for the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#calculationType Read more...} */ calculationType: "planar" | "geodesic" | "preserve-shape" | nullish; /** * The length unit in which perimeters of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#lengthUnit Read more...} */ lengthUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * Input parameters for the areasAndLengths() * method on the GeometryService. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html Read more...} */ constructor(properties?: AreasAndLengthsParametersProperties); /** * Polygon geometries for which to compute areas and lengths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#polygons Read more...} */ get polygons(): Polygon[] | nullish; set polygons(value: PolygonProperties[] | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AreasAndLengthsParameters; } interface AreasAndLengthsParametersProperties { /** * The area unit in which areas of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#areaUnit Read more...} */ areaUnit?: | "acres" | "ares" | "hectares" | "square-miles" | "square-kilometers" | "square-meters" | "square-feet" | "square-yards" | nullish; /** * Defines the type of calculation for the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#calculationType Read more...} */ calculationType?: "planar" | "geodesic" | "preserve-shape" | nullish; /** * The length unit in which perimeters of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#lengthUnit Read more...} */ lengthUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * Polygon geometries for which to compute areas and lengths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AreasAndLengthsParameters.html#polygons Read more...} */ polygons?: PolygonProperties[] | nullish; } export interface AttachmentQuery extends Accessor, JSONSupport { } export class AttachmentQuery { /** * The where clause to be applied to attachment queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#attachmentsWhere Read more...} */ attachmentsWhere: string | nullish; /** * The file format that is supported by query attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#attachmentTypes Read more...} */ attachmentTypes: string[] | nullish; /** * Indicates if the service should cache the attachment query results. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#cacheHint Read more...} */ cacheHint: boolean | nullish; /** * An array of globalIds for the features in the layer being queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#globalIds Read more...} */ globalIds: string[] | nullish; /** * Used to query for attachments that match the provided `keywords`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#keywords Read more...} */ keywords: string[] | nullish; /** * Used to query for attachments that match this `name`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#name Read more...} */ name: string | nullish; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#num Read more...} */ num: number | nullish; /** * An array of objectIds of the features to be queried for attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#objectIds Read more...} */ objectIds: number[]; /** * An array of one or more `attachmentInfo` field names on which the returned queried attachments will be sorted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * If `true`, the [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) for the attachment will be included in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#exifInfo attachmentInfo}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#returnMetadata Read more...} */ returnMetadata: boolean; /** * The file size of the attachment is specified in bytes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#size Read more...} */ size: number[] | nullish; /** * This option fetches query results by skipping a specified number of records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#start Read more...} */ start: number | nullish; /** * The `where` clause to be applied to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#where Read more...} */ where: string | nullish; /** * This class defines parameters for executing queries for feature attachments from a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html Read more...} */ constructor(properties?: AttachmentQueryProperties); /** * Creates a deep clone of AttachmentQuery object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#clone Read more...} */ clone(): AttachmentQuery; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttachmentQuery; } interface AttachmentQueryProperties { /** * The where clause to be applied to attachment queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#attachmentsWhere Read more...} */ attachmentsWhere?: string | nullish; /** * The file format that is supported by query attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#attachmentTypes Read more...} */ attachmentTypes?: string[] | nullish; /** * Indicates if the service should cache the attachment query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#cacheHint Read more...} */ cacheHint?: boolean | nullish; /** * An array of globalIds for the features in the layer being queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#globalIds Read more...} */ globalIds?: string[] | nullish; /** * Used to query for attachments that match the provided `keywords`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#keywords Read more...} */ keywords?: string[] | nullish; /** * Used to query for attachments that match this `name`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#name Read more...} */ name?: string | nullish; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#num Read more...} */ num?: number | nullish; /** * An array of objectIds of the features to be queried for attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#objectIds Read more...} */ objectIds?: number[]; /** * An array of one or more `attachmentInfo` field names on which the returned queried attachments will be sorted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * If `true`, the [Exchangeable image file format](https://en.wikipedia.org/wiki/Exif) for the attachment will be included in * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html#exifInfo attachmentInfo}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#returnMetadata Read more...} */ returnMetadata?: boolean; /** * The file size of the attachment is specified in bytes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#size Read more...} */ size?: number[] | nullish; /** * This option fetches query results by skipping a specified number of records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#start Read more...} */ start?: number | nullish; /** * The `where` clause to be applied to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttachmentQuery.html#where Read more...} */ where?: string | nullish; } export interface AttributeBinsFeatureSet extends FeatureSet, JSONSupport { } export class AttributeBinsFeatureSet { /** * The AttributeBinsFeatureSet is a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-AttributeBinsGraphic.html AttributeBinsGraphic} returned from the `queryAttributeBins()` method based on a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html Read more...} */ constructor(properties?: AttributeBinsFeatureSetProperties); /** * The array of attribute bin graphics returned from a `queryAttributeBins()` operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html#features Read more...} */ get features(): AttributeBinsGraphic[]; set features(value: AttributeBinsGraphicProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeBinsFeatureSet; } interface AttributeBinsFeatureSetProperties extends FeatureSetProperties { /** * The array of attribute bin graphics returned from a `queryAttributeBins()` operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html#features Read more...} */ features?: AttributeBinsGraphicProperties[]; } export interface AttributeBinsGrouping extends Accessor, JSONSupport { } export class AttributeBinsGrouping { /** * The alias is the name assigned to the attribute bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#alias Read more...} */ alias: string | nullish; /** * The type specifies how bin series will be created, indicating whether the bin grouping is based on a field, or an expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#type Read more...} */ type: "field" | "expression"; /** * The name of the field or an expression used when the bins are split or stacked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#value Read more...} */ value: string; /** * Specifies the expected data type of the output from the `stackBy` or `splitBy` parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#valueType Read more...} */ valueType: "integer" | "string" | nullish; /** * AttributeBinsGrouping is a class that defines the `stackBy` or `splitBy` parameter in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html Read more...} */ constructor(properties?: AttributeBinsGroupingProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeBinsGrouping; } interface AttributeBinsGroupingProperties { /** * The alias is the name assigned to the attribute bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#alias Read more...} */ alias?: string | nullish; /** * The type specifies how bin series will be created, indicating whether the bin grouping is based on a field, or an expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#type Read more...} */ type?: "field" | "expression"; /** * The name of the field or an expression used when the bins are split or stacked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#value Read more...} */ value?: string; /** * Specifies the expected data type of the output from the `stackBy` or `splitBy` parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsGrouping.html#valueType Read more...} */ valueType?: "integer" | "string" | nullish; } export interface AttributeBinsQuery extends Accessor, JSONSupport, QueryMixin { } export class AttributeBinsQuery { /** * Bins can be returned in ascending or descending order. * * @default "ascending" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binOrder Read more...} */ binOrder: "ascending" | "descending" | nullish; /** * Indicates if the service should cache the query results. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#cacheHint Read more...} */ declare cacheHint: QueryMixin["cacheHint"]; /** * Datum transformation used for projecting geometries in the query results when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outSpatialReference outSpatialReference} is different than the layer's spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#datumTransformation Read more...} */ datumTransformation: number | SimpleTransformation | CompositeTransformation | nullish; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#distance Read more...} */ declare distance: QueryMixin["distance"]; /** * Sets the name of the lower boundary property in the response. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#lowerBoundaryAlias Read more...} */ lowerBoundaryAlias: string | nullish; /** * Defines the [IANA time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used for bin calculations when the bin parameter field is a date field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outTimeZone Read more...} */ outTimeZone: string | nullish; /** * If `true` then the query returns distinct values based on the field(s) specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outFields outFields}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#returnDistinctValues Read more...} */ returnDistinctValues: boolean | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry geometry}. * * @default intersects * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#spatialRelationship Read more...} */ declare spatialRelationship: QueryMixin["spatialRelationship"]; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#distance distance} is specified in spatial queries. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#units Read more...} */ declare units: QueryMixin["units"]; /** * Sets the name of the upper boundary property in the response. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#upperBoundaryAlias Read more...} */ upperBoundaryAlias: string | nullish; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#where Read more...} */ declare where: QueryMixin["where"]; /** * This class configures parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryAttributeBins queryAttributeBins()} method, which groups features in a layer or layer view into bins * based on numeric or date fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html Read more...} */ constructor(properties?: AttributeBinsQueryProperties); /** * Bin parameters describe the characteristics of the bins, including their size and starting value. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters Read more...} */ get binParameters(): | AutoIntervalBinParameters | FixedIntervalBinParameters | FixedBoundariesBinParameters | DateBinParameters; set binParameters(value: | (AutoIntervalBinParametersProperties & { type: "auto-interval" }) | (FixedIntervalBinParametersProperties & { type: "fixed-interval" }) | (FixedBoundariesBinParametersProperties & { type: "fixed-boundaries" }) | (DateBinParametersProperties & { type: "date" })); /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * The definitions for one or more field-based statistics to be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outStatistics Read more...} */ get outStatistics(): StatisticDefinition[] | nullish; set outStatistics(value: StatisticDefinitionProperties[] | nullish); /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeBinsQuery; } interface AttributeBinsQueryProperties extends QueryMixinProperties { /** * Bins can be returned in ascending or descending order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binOrder Read more...} */ binOrder?: "ascending" | "descending" | nullish; /** * Bin parameters describe the characteristics of the bins, including their size and starting value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters Read more...} */ binParameters?: | (AutoIntervalBinParametersProperties & { type: "auto-interval" }) | (FixedIntervalBinParametersProperties & { type: "fixed-interval" }) | (FixedBoundariesBinParametersProperties & { type: "fixed-boundaries" }) | (DateBinParametersProperties & { type: "date" }); /** * Indicates if the service should cache the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#cacheHint Read more...} */ cacheHint?: QueryMixinProperties["cacheHint"]; /** * Datum transformation used for projecting geometries in the query results when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outSpatialReference outSpatialReference} is different than the layer's spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#datumTransformation Read more...} */ datumTransformation?: number | SimpleTransformation | CompositeTransformation | nullish; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#distance Read more...} */ distance?: QueryMixinProperties["distance"]; /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * Sets the name of the lower boundary property in the response. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#lowerBoundaryAlias Read more...} */ lowerBoundaryAlias?: string | nullish; /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * The definitions for one or more field-based statistics to be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outStatistics Read more...} */ outStatistics?: StatisticDefinitionProperties[] | nullish; /** * Defines the [IANA time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used for bin calculations when the bin parameter field is a date field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outTimeZone Read more...} */ outTimeZone?: string | nullish; /** * If `true` then the query returns distinct values based on the field(s) specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#outFields outFields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#returnDistinctValues Read more...} */ returnDistinctValues?: boolean | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#spatialRelationship Read more...} */ spatialRelationship?: QueryMixinProperties["spatialRelationship"]; /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#distance distance} is specified in spatial queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#units Read more...} */ units?: QueryMixinProperties["units"]; /** * Sets the name of the upper boundary property in the response. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#upperBoundaryAlias Read more...} */ upperBoundaryAlias?: string | nullish; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#where Read more...} */ where?: QueryMixinProperties["where"]; } export interface AutoIntervalBinParameters extends Accessor, JSONSupport, BinParametersBase, NormalizationBinParametersMixin { } export class AutoIntervalBinParameters { /** * The end value of bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#end Read more...} */ end: number | Date | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expression Read more...} */ declare expression: BinParametersBase["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expressionValueType Read more...} */ declare expressionValueType: BinParametersBase["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#field Read more...} */ declare field: BinParametersBase["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#firstDayOfWeek Read more...} */ declare firstDayOfWeek: BinParametersBase["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#hideUpperBound Read more...} */ declare hideUpperBound: BinParametersBase["hideUpperBound"]; /** * Name of the numeric field used to normalize values during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationField Read more...} */ declare normalizationField: NormalizationBinParametersMixin["normalizationField"]; /** * The maximum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationMaxValue Read more...} */ declare normalizationMaxValue: NormalizationBinParametersMixin["normalizationMaxValue"]; /** * The minimum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationMinValue Read more...} */ declare normalizationMinValue: NormalizationBinParametersMixin["normalizationMinValue"]; /** * The total value used when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationType normalizationType} is `percent-of-total`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationTotal Read more...} */ declare normalizationTotal: NormalizationBinParametersMixin["normalizationTotal"]; /** * Normalization type used to normalize data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationType Read more...} */ declare normalizationType: NormalizationBinParametersMixin["normalizationType"]; /** * The number of bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#numBins Read more...} */ numBins: number | nullish; /** * The start value of bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#start Read more...} */ start: number | Date | nullish; /** * The type of bin parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#type Read more...} */ readonly type: "auto-interval"; /** * AutoIntervalBinParameters specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html Read more...} */ constructor(properties?: AutoIntervalBinParametersProperties); /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#splitBy Read more...} */ get splitBy(): AttributeBinsGrouping | nullish; set splitBy(value: AttributeBinsGroupingProperties | nullish); /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#stackBy Read more...} */ get stackBy(): AttributeBinsGrouping | nullish; set stackBy(value: AttributeBinsGroupingProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AutoIntervalBinParameters; } interface AutoIntervalBinParametersProperties extends BinParametersBaseProperties, NormalizationBinParametersMixinProperties { /** * The end value of bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#end Read more...} */ end?: number | Date | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expression Read more...} */ expression?: BinParametersBaseProperties["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#expressionValueType Read more...} */ expressionValueType?: BinParametersBaseProperties["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#field Read more...} */ field?: BinParametersBaseProperties["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#firstDayOfWeek Read more...} */ firstDayOfWeek?: BinParametersBaseProperties["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#hideUpperBound Read more...} */ hideUpperBound?: BinParametersBaseProperties["hideUpperBound"]; /** * Name of the numeric field used to normalize values during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationField Read more...} */ normalizationField?: NormalizationBinParametersMixinProperties["normalizationField"]; /** * The maximum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationMaxValue Read more...} */ normalizationMaxValue?: NormalizationBinParametersMixinProperties["normalizationMaxValue"]; /** * The minimum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationMinValue Read more...} */ normalizationMinValue?: NormalizationBinParametersMixinProperties["normalizationMinValue"]; /** * The total value used when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationType normalizationType} is `percent-of-total`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationTotal Read more...} */ normalizationTotal?: NormalizationBinParametersMixinProperties["normalizationTotal"]; /** * Normalization type used to normalize data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#normalizationType Read more...} */ normalizationType?: NormalizationBinParametersMixinProperties["normalizationType"]; /** * The number of bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#numBins Read more...} */ numBins?: number | nullish; /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#splitBy Read more...} */ splitBy?: AttributeBinsGroupingProperties | nullish; /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#stackBy Read more...} */ stackBy?: AttributeBinsGroupingProperties | nullish; /** * The start value of bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AutoIntervalBinParameters.html#start Read more...} */ start?: number | Date | nullish; } export interface BaseImageMeasureParameters extends Accessor, JSONSupport { } export class BaseImageMeasureParameters { /** * Base class for imagery mensuration operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html Read more...} */ constructor(properties?: BaseImageMeasureParametersProperties); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the measure is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule | nullish; set mosaicRule(value: MosaicRuleProperties | nullish); /** * Specifies the pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#pixelSize Read more...} */ get pixelSize(): Point; set pixelSize(value: PointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BaseImageMeasureParameters; } interface BaseImageMeasureParametersProperties { /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the measure is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties | nullish; /** * Specifies the pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureParameters.html#pixelSize Read more...} */ pixelSize?: PointProperties; } export interface BaseImageMeasureResult extends Accessor, JSONSupport { } export class BaseImageMeasureResult { /** * Name of the raster dataset used in the area and height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#name Read more...} */ name: string; /** * Sensor name of the raster dataset used in the area and height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#sensorName Read more...} */ sensorName: string; /** * Base class for image service measure result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html Read more...} */ constructor(properties?: BaseImageMeasureResultProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BaseImageMeasureResult; } interface BaseImageMeasureResultProperties { /** * Name of the raster dataset used in the area and height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#name Read more...} */ name?: string; /** * Sensor name of the raster dataset used in the area and height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BaseImageMeasureResult.html#sensorName Read more...} */ sensorName?: string; } export class BinParametersBase { expression: string | nullish; expressionValueType: | "small-integer" | "integer" | "single" | "double" | "long" | "date-only" | "time-only" | "timestamp-offset" | "date" | nullish; field: string | nullish; firstDayOfWeek: number | nullish; hideUpperBound: boolean | nullish; get splitBy(): AttributeBinsGrouping | nullish; set splitBy(value: AttributeBinsGroupingProperties | nullish); get stackBy(): AttributeBinsGrouping | nullish; set stackBy(value: AttributeBinsGroupingProperties | nullish); } interface BinParametersBaseProperties { expression?: string | nullish; expressionValueType?: | "small-integer" | "integer" | "single" | "double" | "long" | "date-only" | "time-only" | "timestamp-offset" | "date" | nullish; field?: string | nullish; firstDayOfWeek?: number | nullish; hideUpperBound?: boolean | nullish; splitBy?: AttributeBinsGroupingProperties | nullish; stackBy?: AttributeBinsGroupingProperties | nullish; } export interface BufferParameters extends Accessor, JSONSupport { } export class BufferParameters { /** * The distances the input features are buffered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#distances Read more...} */ distances: number[] | nullish; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to * generate a buffer polygon using a geodesic distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#geodesic Read more...} */ geodesic: boolean; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#unionResults Read more...} */ unionResults: boolean; /** * The units for calculating each buffer distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#unit Read more...} */ unit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * Sets the distances, units, and other parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#buffer buffer()} * method on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html geometryService}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html Read more...} */ constructor(properties?: BufferParametersProperties); /** * The spatial reference in which the geometries are buffered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#bufferSpatialReference Read more...} */ get bufferSpatialReference(): SpatialReference | nullish; set bufferSpatialReference(value: SpatialReferenceProperties | nullish); /** * The input geometries to buffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#geometries Read more...} */ get geometries(): GeometryUnion[]; set geometries(value: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]); /** * The spatial reference for the returned geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): BufferParameters; } interface BufferParametersProperties { /** * The spatial reference in which the geometries are buffered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#bufferSpatialReference Read more...} */ bufferSpatialReference?: SpatialReferenceProperties | nullish; /** * The distances the input features are buffered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#distances Read more...} */ distances?: number[] | nullish; /** * If the input geometries are in a geographic coordinate system, set geodesic to `true` to * generate a buffer polygon using a geodesic distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#geodesic Read more...} */ geodesic?: boolean; /** * The input geometries to buffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#geometries Read more...} */ geometries?: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]; /** * The spatial reference for the returned geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#unionResults Read more...} */ unionResults?: boolean; /** * The units for calculating each buffer distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-BufferParameters.html#unit Read more...} */ unit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; } export class CameraInfo extends JSONSupport { /** * Camera's columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#cols Read more...} */ cols: number; /** * Camera's focal length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#focalLength Read more...} */ focalLength: number | nullish; /** * Camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#id Read more...} */ id: string; /** * Camera's manufacturer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#make Read more...} */ make: string; /** * Camera's model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#model Read more...} */ model: string; /** * Camera's pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#pixelSize Read more...} */ pixelSize: number | nullish; /** * Camera's rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#rows Read more...} */ rows: number; /** * Camera information returned as a result of running {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryGPSInfo ImageryLayer.queryGPSInfo()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryGPSInfo imageService.queryGPSInfo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html Read more...} */ constructor(properties?: CameraInfoProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): CameraInfo; } interface CameraInfoProperties { /** * Camera's columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#cols Read more...} */ cols?: number; /** * Camera's focal length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#focalLength Read more...} */ focalLength?: number | nullish; /** * Camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#id Read more...} */ id?: string; /** * Camera's manufacturer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#make Read more...} */ make?: string; /** * Camera's model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#model Read more...} */ model?: string; /** * Camera's pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#pixelSize Read more...} */ pixelSize?: number | nullish; /** * Camera's rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-CameraInfo.html#rows Read more...} */ rows?: number; } 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#accumulateAttributes Read more...} */ accumulateAttributes: string[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#apiKey Read more...} */ apiKey: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#attributeParameterValues Read more...} */ attributeParameterValues: AttributeParameterValue[] | nullish; /** * The travel time or travel distance value at which to stop searching for facilities for a given incident. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#defaultCutoff Read more...} */ defaultCutoff: number | nullish; /** * The number of closest facilities to find per incident. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#defaultTargetFacilityCount Read more...} */ defaultTargetFacilityCount: number | nullish; /** * The language that will be used when generating travel directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsLanguage Read more...} */ directionsLanguage: string | nullish; /** * Specify the units for displaying travel distance in the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsLengthUnits Read more...} */ directionsLengthUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Define the content and verbosity of the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsOutputType Read more...} */ directionsOutputType: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only" | nullish; /** * Specify the name of the formatting style for the directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsStyleName Read more...} */ directionsStyleName: "desktop" | "navigation" | "campus" | nullish; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado * St. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsTimeAttribute Read more...} */ directionsTimeAttribute: | "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string | nullish; /** * One or more locations that are searched for when finding the closest location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#facilities Read more...} */ facilities: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#impedanceAttribute Read more...} */ impedanceAttribute: string | nullish; /** * One or more locations from which the service searches for the nearby locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#incidents Read more...} */ incidents: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputLines Read more...} */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#overrides Read more...} */ overrides: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#pointBarriers Read more...} */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polygonBarriers Read more...} */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polylineBarriers Read more...} */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#preserveObjectID Read more...} */ preserveObjectID: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Specifies how U-Turns should be handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#restrictUTurns Read more...} */ restrictUTurns: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnDirections Read more...} */ returnDirections: boolean | nullish; /** * Determines if facilities will be returned by the service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnFacilities Read more...} */ returnFacilities: boolean | nullish; /** * Determines if incidents will be returned by the service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnIncidents Read more...} */ returnIncidents: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPointBarriers Read more...} */ returnPointBarriers: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers: boolean | nullish; /** * Use this property to specify if the operation should return routes. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnRoutes Read more...} */ returnRoutes: boolean | nullish; /** * Specify whether traversed edges will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedEdges Read more...} */ returnTraversedEdges: boolean | nullish; /** * Specify whether traversed junctions will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedJunctions Read more...} */ returnTraversedJunctions: boolean | nullish; /** * Specify whether traversed turns will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedTurns Read more...} */ returnTraversedTurns: boolean | nullish; /** * Include z values for the returned geometries if supported by the underlying network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnZ Read more...} */ returnZ: boolean | nullish; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay Read more...} */ timeOfDay: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay timeOfDay} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDayIsUTC Read more...} */ timeOfDayIsUTC: boolean | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay timeOfDay} parameter value represents the arrival or departure time for the routes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDayUsage Read more...} */ timeOfDayUsage: "start" | "end" | "not-used" | nullish; /** * Specifies how the travel direction for the closest facility search will be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#travelDirection Read more...} */ travelDirection: "from-facility" | "to-facility" | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#useHierarchy Read more...} */ useHierarchy: boolean | nullish; /** * ClosestFacilityParameters provides the input parameters for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html closestFacility} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html Read more...} */ constructor(properties?: ClosestFacilityParametersProperties); /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#travelMode Read more...} */ get travelMode(): TravelMode | nullish; set travelMode(value: TravelModeProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ClosestFacilityParameters; } interface ClosestFacilityParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#accumulateAttributes Read more...} */ accumulateAttributes?: string[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#apiKey Read more...} */ apiKey?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#attributeParameterValues Read more...} */ attributeParameterValues?: AttributeParameterValue[] | nullish; /** * The travel time or travel distance value at which to stop searching for facilities for a given incident. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#defaultCutoff Read more...} */ defaultCutoff?: number | nullish; /** * The number of closest facilities to find per incident. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#defaultTargetFacilityCount Read more...} */ defaultTargetFacilityCount?: number | nullish; /** * The language that will be used when generating travel directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsLanguage Read more...} */ directionsLanguage?: string | nullish; /** * Specify the units for displaying travel distance in the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsLengthUnits Read more...} */ directionsLengthUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Define the content and verbosity of the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsOutputType Read more...} */ directionsOutputType?: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only" | nullish; /** * Specify the name of the formatting style for the directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsStyleName Read more...} */ directionsStyleName?: "desktop" | "navigation" | "campus" | nullish; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado * St. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsTimeAttribute Read more...} */ directionsTimeAttribute?: | "travel-time" | "truck-travel-time" | "walk-time" | "minutes" | "truck-time" | string | nullish; /** * One or more locations that are searched for when finding the closest location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#facilities Read more...} */ facilities?: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ?: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations?: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#impedanceAttribute Read more...} */ impedanceAttribute?: string | nullish; /** * One or more locations from which the service searches for the nearby locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#incidents Read more...} */ incidents?: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision?: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outputLines Read more...} */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#overrides Read more...} */ overrides?: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#pointBarriers Read more...} */ pointBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polygonBarriers Read more...} */ polygonBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polylineBarriers Read more...} */ polylineBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#preserveObjectID Read more...} */ preserveObjectID?: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Specifies how U-Turns should be handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#restrictUTurns Read more...} */ restrictUTurns?: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Specify whether the operation should generate driving directions for each route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnDirections Read more...} */ returnDirections?: boolean | nullish; /** * Determines if facilities will be returned by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnFacilities Read more...} */ returnFacilities?: boolean | nullish; /** * Determines if incidents will be returned by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnIncidents Read more...} */ returnIncidents?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPointBarriers Read more...} */ returnPointBarriers?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers?: boolean | nullish; /** * Use this property to specify if the operation should return routes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnRoutes Read more...} */ returnRoutes?: boolean | nullish; /** * Specify whether traversed edges will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedEdges Read more...} */ returnTraversedEdges?: boolean | nullish; /** * Specify whether traversed junctions will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedJunctions Read more...} */ returnTraversedJunctions?: boolean | nullish; /** * Specify whether traversed turns will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnTraversedTurns Read more...} */ returnTraversedTurns?: boolean | nullish; /** * Include z values for the returned geometries if supported by the underlying network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnZ Read more...} */ returnZ?: boolean | nullish; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay Read more...} */ timeOfDay?: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay timeOfDay} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDayIsUTC Read more...} */ timeOfDayIsUTC?: boolean | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDay timeOfDay} parameter value represents the arrival or departure time for the routes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#timeOfDayUsage Read more...} */ timeOfDayUsage?: "start" | "end" | "not-used" | nullish; /** * Specifies how the travel direction for the closest facility search will be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#travelDirection Read more...} */ travelDirection?: "from-facility" | "to-facility" | nullish; /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#travelMode Read more...} */ travelMode?: TravelModeProperties | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#useHierarchy Read more...} */ useHierarchy?: boolean | nullish; } /** * An object describing the parameter values for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#attributeParameterValues attributeParameterValues} property of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html ClosestFacilityParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#AttributeParameterValue Read more...} */ export interface AttributeParameterValue { attributeName: string; parameterName: string; value: string | number | nullish; } export interface ClosestFacilitySolveResult extends Accessor, JSONSupport { } export class ClosestFacilitySolveResult { /** * The result from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html closestFacility}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html Read more...} */ constructor(properties?: ClosestFacilitySolveResultProperties); /** * Direction lines contains a set of line features for each segment of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directionLines Read more...} */ get directionLines(): FeatureSet | nullish; set directionLines(value: FeatureSetProperties | nullish); /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directionPoints Read more...} */ get directionPoints(): FeatureSet | nullish; set directionPoints(value: FeatureSetProperties | nullish); /** * Directions are returned if * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnDirections ClosestFacilityParameters.returnDirections} is set to `true` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsOutputType ClosestFacilityParameters.directionsOutputType} is set * to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html#solve closestFacility.solve()} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directions Read more...} */ get directions(): DirectionsFeatureSet[] | nullish; set directions(value: DirectionsFeatureSetProperties[] | nullish); /** * This provides access to the output facilities from a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#facilities Read more...} */ get facilities(): FeatureSet | nullish; set facilities(value: FeatureSetProperties | nullish); /** * This provides access to the locations used as starting or ending points in a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#incidents Read more...} */ get incidents(): FeatureSet | nullish; set incidents(value: FeatureSetProperties | nullish); /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#messages Read more...} */ get messages(): NAMessage[] | nullish; set messages(value: NAMessageProperties[] | nullish); /** * A set of features representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#pointBarriers Read more...} */ get pointBarriers(): FeatureSet | nullish; set pointBarriers(value: FeatureSetProperties | nullish); /** * A set of features representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#polygonBarriers Read more...} */ get polygonBarriers(): FeatureSet | nullish; set polygonBarriers(value: FeatureSetProperties | nullish); /** * A set of features representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#polylineBarriers Read more...} */ get polylineBarriers(): FeatureSet | nullish; set polylineBarriers(value: FeatureSetProperties | nullish); /** * A set of features representing routes between the facilities and the incidents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#routes Read more...} */ get routes(): FeatureSet | nullish; set routes(value: FeatureSetProperties | nullish); /** * This provides access to the edges that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedEdges Read more...} */ get traversedEdges(): FeatureSet | nullish; set traversedEdges(value: FeatureSetProperties | nullish); /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedJunctions Read more...} */ get traversedJunctions(): FeatureSet | nullish; set traversedJunctions(value: FeatureSetProperties | nullish); /** * This provides access to the turns that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedTurns Read more...} */ get traversedTurns(): FeatureSet | nullish; set traversedTurns(value: FeatureSetProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ClosestFacilitySolveResult; } interface ClosestFacilitySolveResultProperties { /** * Direction lines contains a set of line features for each segment of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directionLines Read more...} */ directionLines?: FeatureSetProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directionPoints Read more...} */ directionPoints?: FeatureSetProperties | nullish; /** * Directions are returned if * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#returnDirections ClosestFacilityParameters.returnDirections} is set to `true` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilityParameters.html#directionsOutputType ClosestFacilityParameters.directionsOutputType} is set * to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-closestFacility.html#solve closestFacility.solve()} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#directions Read more...} */ directions?: DirectionsFeatureSetProperties[] | nullish; /** * This provides access to the output facilities from a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#facilities Read more...} */ facilities?: FeatureSetProperties | nullish; /** * This provides access to the locations used as starting or ending points in a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#incidents Read more...} */ incidents?: FeatureSetProperties | nullish; /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#messages Read more...} */ messages?: NAMessageProperties[] | nullish; /** * A set of features representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#pointBarriers Read more...} */ pointBarriers?: FeatureSetProperties | nullish; /** * A set of features representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#polygonBarriers Read more...} */ polygonBarriers?: FeatureSetProperties | nullish; /** * A set of features representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#polylineBarriers Read more...} */ polylineBarriers?: FeatureSetProperties | nullish; /** * A set of features representing routes between the facilities and the incidents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#routes Read more...} */ routes?: FeatureSetProperties | nullish; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedEdges Read more...} */ traversedEdges?: FeatureSetProperties | nullish; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedJunctions Read more...} */ traversedJunctions?: FeatureSetProperties | nullish; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ClosestFacilitySolveResult.html#traversedTurns Read more...} */ traversedTurns?: FeatureSetProperties | nullish; } export interface ColorRamp extends Accessor, JSONSupport { } export class ColorRamp { /** * A string value representing the color ramp type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ColorRamp.html#type Read more...} */ readonly type: "algorithmic" | "multipart" | nullish; /** * A ColorRamp object is used to specify a range of colors that are applied to a group of symbols or pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ColorRamp.html Read more...} */ constructor(properties?: ColorRampProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ColorRamp.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ColorRamp.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#itemId Read more...} */ itemId: string | nullish; /** * URL to the location of the data file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#url Read more...} */ url: string | nullish; /** * A geoprocessing data object containing a data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html Read more...} */ constructor(properties?: DataFileProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DataFile; } interface DataFileProperties { /** * The ID of the uploaded file returned as a result of the upload operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#itemId Read more...} */ itemId?: string | nullish; /** * URL to the location of the data file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataFile.html#url Read more...} */ url?: string | nullish; } export interface DataLayer extends Accessor, JSONSupport { } export class DataLayer { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements: boolean | nullish; /** * The type of geometry specified by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometry geometry} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometryType Read more...} */ geometryType: "point" | "polyline" | "polygon" | "envelope" | "multipoint" | nullish; /** * The name of the data layer in the map service that is being referenced. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#name Read more...} */ name: string | nullish; /** * The spatial relationship to be applied on the input geometry while * performing the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#spatialRelationship Read more...} */ spatialRelationship: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation" | nullish; type: "layer"; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#where Read more...} */ where: string | nullish; /** * Input for properties of ClosestFacilityParameters, RouteParameters or ServiceAreaParameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html Read more...} */ constructor(properties?: DataLayerProperties); /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DataLayer; } interface DataLayerProperties { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements?: boolean | nullish; /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * The type of geometry specified by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometry geometry} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#geometryType Read more...} */ geometryType?: "point" | "polyline" | "polygon" | "envelope" | "multipoint" | nullish; /** * The name of the data layer in the map service that is being referenced. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#name Read more...} */ name?: string | nullish; /** * The spatial relationship to be applied on the input geometry while * performing the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#spatialRelationship Read more...} */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation" | nullish; type?: "layer"; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DataLayer.html#where Read more...} */ where?: string | nullish; } export interface DateBinParameters extends Accessor, JSONSupport, BinParametersBase { } export class DateBinParameters { /** * The end date value for bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#end Read more...} */ end: Date | string | number | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expression Read more...} */ declare expression: BinParametersBase["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expressionValueType Read more...} */ declare expressionValueType: BinParametersBase["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#field Read more...} */ declare field: BinParametersBase["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#firstDayOfWeek Read more...} */ declare firstDayOfWeek: BinParametersBase["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#hideUpperBound Read more...} */ declare hideUpperBound: BinParametersBase["hideUpperBound"]; /** * Indicates whether the last bin should match the specified interval size exactly. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#returnFullIntervalBin Read more...} */ returnFullIntervalBin: boolean; /** * This property determines how the bins are aligned relative to the data points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#snapToData Read more...} */ snapToData: "first" | "last" | nullish; /** * The start date value for bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#start Read more...} */ start: Date | string | number | nullish; /** * The type of bin parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#type Read more...} */ readonly type: "date"; /** * DateBinParameters specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html Read more...} */ constructor(properties?: DateBinParametersProperties); /** * Defines a length of time in one of the temporal units such as `days`, `weeks`, or `years`. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#interval Read more...} */ get interval(): DateBinTimeInterval; set interval(value: DateBinTimeIntervalProperties); /** * Defines an offset to the bin's starting position. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#offset Read more...} */ get offset(): DateBinTimeInterval | nullish; set offset(value: DateBinTimeIntervalProperties | nullish); /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#splitBy Read more...} */ get splitBy(): AttributeBinsGrouping | nullish; set splitBy(value: AttributeBinsGroupingProperties | nullish); /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#stackBy Read more...} */ get stackBy(): AttributeBinsGrouping | nullish; set stackBy(value: AttributeBinsGroupingProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DateBinParameters; } interface DateBinParametersProperties extends BinParametersBaseProperties { /** * The end date value for bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#end Read more...} */ end?: Date | string | number | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expression Read more...} */ expression?: BinParametersBaseProperties["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#expressionValueType Read more...} */ expressionValueType?: BinParametersBaseProperties["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#field Read more...} */ field?: BinParametersBaseProperties["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#firstDayOfWeek Read more...} */ firstDayOfWeek?: BinParametersBaseProperties["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#hideUpperBound Read more...} */ hideUpperBound?: BinParametersBaseProperties["hideUpperBound"]; /** * Defines a length of time in one of the temporal units such as `days`, `weeks`, or `years`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#interval Read more...} */ interval?: DateBinTimeIntervalProperties; /** * Defines an offset to the bin's starting position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#offset Read more...} */ offset?: DateBinTimeIntervalProperties | nullish; /** * Indicates whether the last bin should match the specified interval size exactly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#returnFullIntervalBin Read more...} */ returnFullIntervalBin?: boolean; /** * This property determines how the bins are aligned relative to the data points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#snapToData Read more...} */ snapToData?: "first" | "last" | nullish; /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#splitBy Read more...} */ splitBy?: AttributeBinsGroupingProperties | nullish; /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#stackBy Read more...} */ stackBy?: AttributeBinsGroupingProperties | nullish; /** * The start date value for bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinParameters.html#start Read more...} */ start?: Date | string | number | nullish; } export interface DateBinTimeInterval extends Accessor, JSONSupport { } export class DateBinTimeInterval { /** * Temporal unit used to generate bins or defines and an offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#unit Read more...} */ unit: "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"; /** * The numerical value of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#value Read more...} */ value: number; /** * DateBinTimeInterval describes a length of time for a bin query in one of the temporal units such as `days`, `weeks`, or `years`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html Read more...} */ constructor(properties?: DateBinTimeIntervalProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DateBinTimeInterval; } interface DateBinTimeIntervalProperties { /** * Temporal unit used to generate bins or defines and an offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#unit Read more...} */ unit?: "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"; /** * The numerical value of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DateBinTimeInterval.html#value Read more...} */ value?: number; } export class DensifyParameters extends Accessor { /** * If `true`, Geographic Coordinate System spatial references are used or * densify geodesic will be performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#geodesic Read more...} */ geodesic: boolean | nullish; /** * The length unit of `maxSegmentLength`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#lengthUnit Read more...} */ lengthUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines * no longer than `maxSegmentLength.`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#maxSegmentLength Read more...} */ maxSegmentLength: number | nullish; /** * Input parameters for the densify() method on * the GeometryService. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html Read more...} */ constructor(properties?: DensifyParametersProperties); /** * The array of geometries to be densified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#geometries Read more...} */ get geometries(): GeometryUnion[] | nullish; set geometries(value: | ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[] | nullish); /** * Converts an instance of this class to its GeoScene portal JSON representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#toJSON Read more...} */ toJSON(): any; } interface DensifyParametersProperties { /** * If `true`, Geographic Coordinate System spatial references are used or * densify geodesic will be performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#geodesic Read more...} */ geodesic?: boolean | nullish; /** * The array of geometries to be densified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#geometries Read more...} */ geometries?: | ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[] | nullish; /** * The length unit of `maxSegmentLength`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#lengthUnit Read more...} */ lengthUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * All segments longer than `maxSegmentLength` are replaced with sequences of lines * no longer than `maxSegmentLength.`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DensifyParameters.html#maxSegmentLength Read more...} */ maxSegmentLength?: number | nullish; } export interface DirectionLine extends Accessor, JSONSupport { } export class DirectionLine { /** * The type of line which is defined by esriDirectionLineType. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#directionLineType Read more...} */ directionLineType: | "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic" | nullish; /** * Length of the line measured in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#distance Read more...} */ distance: number | nullish; /** * Time of the line measured in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#duration Read more...} */ duration: number | nullish; readonly type: "direction-line"; /** * The DirectionLine represents polylines associated with individual direction items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html Read more...} */ constructor(properties?: DirectionLineProperties); /** * Polyline representing the direction's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#geometry Read more...} */ get geometry(): Polyline | nullish; set geometry(value: PolylineProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html DirectionLine} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html DirectionLine} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): DirectionLine; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DirectionLine; } interface DirectionLineProperties { /** * The type of line which is defined by esriDirectionLineType. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#directionLineType Read more...} */ directionLineType?: | "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic" | nullish; /** * Length of the line measured in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#distance Read more...} */ distance?: number | nullish; /** * Time of the line measured in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#duration Read more...} */ duration?: number | nullish; /** * Polyline representing the direction's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#geometry Read more...} */ geometry?: PolylineProperties | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionLine.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; } export interface DirectionPoint extends Accessor, JSONSupport { } export class DirectionPoint { /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#arrivalTimeOffset Read more...} */ arrivalTimeOffset: number | nullish; /** * The type of directions event or maneuver described by the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#directionPointType Read more...} */ 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" | "lane" | "time-zone-change" | "traffic-event" | "scaled-cost-barrier-event" | "boundary-crossing" | "restriction-violation" | nullish; /** * The direction item text to dispay on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#displayText Read more...} */ displayText: string | nullish; /** * Sequence of the Direction items, starting with 1. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#sequence Read more...} */ sequence: number | nullish; readonly type: "direction-point"; /** * The DirectionPoint represents direction items as points with various display information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html Read more...} */ constructor(properties?: DirectionPointProperties); /** * Time when the action happens. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#arrivalTime Read more...} */ get arrivalTime(): Date | nullish; set arrivalTime(value: DateProperties | nullish); /** * Point representing the direction's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#geometry Read more...} */ get geometry(): Point | nullish; set geometry(value: PointProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html DirectionPoint} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html DirectionPoint} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): DirectionPoint; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DirectionPoint; } interface DirectionPointProperties { /** * Time when the action happens. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#arrivalTime Read more...} */ arrivalTime?: DateProperties | nullish; /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#arrivalTimeOffset Read more...} */ arrivalTimeOffset?: number | nullish; /** * The type of directions event or maneuver described by the point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#directionPointType Read more...} */ 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" | "lane" | "time-zone-change" | "traffic-event" | "scaled-cost-barrier-event" | "boundary-crossing" | "restriction-violation" | nullish; /** * The direction item text to dispay on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#displayText Read more...} */ displayText?: string | nullish; /** * Point representing the direction's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#geometry Read more...} */ geometry?: PointProperties | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * Sequence of the Direction items, starting with 1. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionPoint.html#sequence Read more...} */ sequence?: number | nullish; } export interface DirectionsEvent extends Accessor, JSONSupport { } export class DirectionsEvent { /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#arriveTimeOffset Read more...} */ arriveTimeOffset: number | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#DirectionsString direction strings}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#strings Read more...} */ strings: DirectionsString[] | nullish; /** * DirectionsEvent represent {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeature.html#events events} for features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html DirectionsFeatureSet}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html Read more...} */ constructor(properties?: DirectionsEventProperties); /** * The date and time value indicating the arrival time at the Directions Event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#arriveTime Read more...} */ get arriveTime(): Date | nullish; set arriveTime(value: DateProperties | nullish); /** * The point location of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#geometry Read more...} */ get geometry(): Point | nullish; set geometry(value: PointProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DirectionsEvent; } interface DirectionsEventProperties { /** * The date and time value indicating the arrival time at the Directions Event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#arriveTime Read more...} */ arriveTime?: DateProperties | nullish; /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#arriveTimeOffset Read more...} */ arriveTimeOffset?: number | nullish; /** * The point location of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#geometry Read more...} */ geometry?: PointProperties | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#DirectionsString direction strings}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsEvent.html#strings Read more...} */ strings?: DirectionsString[] | nullish; } export class DirectionsFeature { /** * Name-value pairs of fields and field values associated with the Directions Feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeature.html#attributes Read more...} */ attributes: any; /** * An array of Direction Events. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeature.html#events Read more...} */ events: DirectionsEvent[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#DirectionsString direction strings}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeature.html#strings Read more...} */ strings: DirectionsString[] | nullish; constructor(properties?: any); /** * The geometry of the Directions Feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeature.html#geometry Read more...} */ get geometry(): Polyline | nullish; set geometry(value: PolylineProperties | nullish); } export interface DirectionsFeatureSet extends FeatureSet, Accessor { } export class DirectionsFeatureSet { /** * The geometry type of the Directions FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#geometryType Read more...} */ geometryType: "polyline"; /** * A single polyline representing the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#mergedGeometry Read more...} */ readonly mergedGeometry: Polyline | nullish; /** * The ID of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#routeId Read more...} */ routeId: number | nullish; /** * The name of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#routeName Read more...} */ routeName: string | nullish; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#DirectionsString direction strings}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#strings Read more...} */ readonly strings: DirectionsString[]; /** * The total drive time for the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalDriveTime Read more...} */ totalDriveTime: number | nullish; /** * The total length of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalLength Read more...} */ totalLength: number | nullish; /** * The total time for the route including wait and service time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalTime Read more...} */ totalTime: number | nullish; /** * DirectionsFeatureSet is a subclass of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} that contains street directions * for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve solved route}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html Read more...} */ constructor(properties?: DirectionsFeatureSetProperties); /** * The extent of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#extent Read more...} */ get extent(): Extent; set extent(value: ExtentProperties); static fromJSON(json: any): DirectionsFeatureSet; } interface DirectionsFeatureSetProperties extends FeatureSetProperties { /** * The extent of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#extent Read more...} */ extent?: ExtentProperties; /** * The geometry type of the Directions FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#geometryType Read more...} */ geometryType?: "polyline"; /** * The ID of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#routeId Read more...} */ routeId?: number | nullish; /** * The name of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#routeName Read more...} */ routeName?: string | nullish; /** * The total drive time for the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalDriveTime Read more...} */ totalDriveTime?: number | nullish; /** * The total length of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalLength Read more...} */ totalLength?: number | nullish; /** * The total time for the route including wait and service time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#totalTime Read more...} */ totalTime?: number | nullish; } /** * An event string object with name and type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DirectionsFeatureSet.html#DirectionsString Read more...} */ export interface DirectionsString { text: string; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 geometry1} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 geometry2}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#distanceUnit Read more...} */ distanceUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * When `true`, the geodesic distance between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 geometry1} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 geometry2} is measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geodesic Read more...} */ geodesic: boolean | nullish; /** * Defines the input parameters when calling * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#distance geometryService.distance()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html Read more...} */ constructor(properties?: DistanceParametersProperties); /** * The geometry from which the distance is to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 Read more...} */ get geometry1(): GeometryUnion | nullish; set geometry1(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The geometry to which the distance is to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 Read more...} */ get geometry2(): GeometryUnion | nullish; set geometry2(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * Converts an instance of this class to its GeoScene portal JSON representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#toJSON Read more...} */ toJSON(): any; } interface DistanceParametersProperties { /** * Specifies the units for measuring distance between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 geometry1} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 geometry2}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#distanceUnit Read more...} */ distanceUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * When `true`, the geodesic distance between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 geometry1} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 geometry2} is measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geodesic Read more...} */ geodesic?: boolean | nullish; /** * The geometry from which the distance is to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry1 Read more...} */ geometry1?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * The geometry to which the distance is to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-DistanceParameters.html#geometry2 Read more...} */ geometry2?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; } export interface FeatureSet extends Accessor, JSONSupport { } export class FeatureSet { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#displayFieldName Read more...} */ displayFieldName: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#exceededTransferLimit Read more...} */ exceededTransferLimit: boolean; /** * The geometry type of features in the FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#geometryType Read more...} */ geometryType: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * A collection of features returned from GeoScene Server or used as input to methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html Read more...} */ constructor(properties?: FeatureSetProperties); /** * The array of graphics returned from a task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#features Read more...} */ get features(): Graphic[]; set features(value: GraphicProperties[]); /** * Information about each field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#fields Read more...} */ get fields(): Field[]; set fields(value: FieldProperties[]); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} used to query the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#queryGeometry Read more...} */ get queryGeometry(): GeometryUnion | nullish; set queryGeometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureSet; } interface FeatureSetProperties { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#displayFieldName Read more...} */ displayFieldName?: string; /** * Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#exceededTransferLimit Read more...} */ exceededTransferLimit?: boolean; /** * The array of graphics returned from a task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#features Read more...} */ features?: GraphicProperties[]; /** * Information about each field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#fields Read more...} */ fields?: FieldProperties[]; /** * The geometry type of features in the FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#geometryType Read more...} */ geometryType?: "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} used to query the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#queryGeometry Read more...} */ queryGeometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; } export class FetchPlaceParameters extends PlacesParameters { /** * The Id of the place that you want to fetch additional details. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html#placeId Read more...} */ placeId: string | nullish; /** * The array of fields that define the attributes to return for a place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html#requestedFields Read more...} */ requestedFields: string[] | nullish; /** * The following properties define the parameters for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#fetchPlace fetchPlace()} method pointing to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html#url url} that represents a places service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html Read more...} */ constructor(properties?: FetchPlaceParametersProperties); } interface FetchPlaceParametersProperties extends PlacesParametersProperties { /** * The Id of the place that you want to fetch additional details. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html#placeId Read more...} */ placeId?: string | nullish; /** * The array of fields that define the attributes to return for a place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FetchPlaceParameters.html#requestedFields Read more...} */ requestedFields?: string[] | nullish; } export class FindImagesParameters extends JSONSupport { /** * The maximum image count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#maxCount Read more...} */ maxCount: number | nullish; /** * An array of ObjectIDs to filter images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#objectIds Read more...} */ objectIds: (number | string)[] | nullish; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#where Read more...} */ where: string | nullish; /** * Input parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#findImages ImageryLayer.findImages()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#findImages imageService.findImages()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html Read more...} */ constructor(properties?: FindImagesParametersProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry with `z` value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#fromGeometry Read more...} */ get fromGeometry(): Point; set fromGeometry(value: PointProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry with `z` value that defines the target geometry's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#toGeometry Read more...} */ get toGeometry(): Point; set toGeometry(value: PointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FindImagesParameters; } interface FindImagesParametersProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry with `z` value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#fromGeometry Read more...} */ fromGeometry?: PointProperties; /** * The maximum image count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#maxCount Read more...} */ maxCount?: number | nullish; /** * An array of ObjectIDs to filter images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#objectIds Read more...} */ objectIds?: (number | string)[] | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry with `z` value that defines the target geometry's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#toGeometry Read more...} */ toGeometry?: PointProperties; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#where Read more...} */ where?: string | nullish; } export class FindImagesResult extends JSONSupport { /** * Results for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#findImages ImageryLayer.findImages()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#findImages imageService.findImages()} methods containing images that meet the search requirements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesResult.html Read more...} */ constructor(properties?: FindImagesResultProperties); /** * An array of image inspection information found between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#fromGeometry fromGeometry} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#toGeometry toGeometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesResult.html#images Read more...} */ get images(): ImageInspectionInfo[]; set images(value: ImageInspectionInfoProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FindImagesResult; } interface FindImagesResultProperties { /** * An array of image inspection information found between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#fromGeometry fromGeometry} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesParameters.html#toGeometry toGeometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindImagesResult.html#images Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#contains Read more...} */ contains: boolean; /** * Specify the geodatabase version to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Specify the number of decimal places for the geometries returned by the task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * The layers to perform the find operation on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#layerIds Read more...} */ layerIds: number[] | nullish; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#maxAllowableOffset Read more...} */ maxAllowableOffset: number | nullish; /** * If `true`, the output will include the geometry associated with each result. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * The names of the fields of a layer to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchFields Read more...} */ searchFields: string[] | nullish; /** * The text that is searched across the layers and the fields as specified in the `layers` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchFields searchFields} properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchText Read more...} */ searchText: string | nullish; /** * Input parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-find.html find}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html Read more...} */ constructor(properties?: FindParametersProperties); /** * The spatial reference of the output geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FindParameters; } interface FindParametersProperties { /** * Determines whether to look for an exact match of the search text or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#contains Read more...} */ contains?: boolean; /** * Specify the geodatabase version to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * Specify the number of decimal places for the geometries returned by the task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * The layers to perform the find operation on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#layerIds Read more...} */ layerIds?: number[] | nullish; /** * The maximum allowable offset used for generalizing geometries returned by the find operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#maxAllowableOffset Read more...} */ maxAllowableOffset?: number | nullish; /** * The spatial reference of the output geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * If `true`, the output will include the geometry associated with each result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * The names of the fields of a layer to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchFields Read more...} */ searchFields?: string[] | nullish; /** * The text that is searched across the layers and the fields as specified in the `layers` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchFields searchFields} properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindParameters.html#searchText Read more...} */ searchText?: string | nullish; } export interface FindResult extends Accessor, JSONSupport { } export class FindResult { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#displayFieldName Read more...} */ displayFieldName: string | nullish; /** * The name of the field that contains the search text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#foundFieldName Read more...} */ foundFieldName: string | nullish; /** * Unique ID of the layer that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#layerId Read more...} */ layerId: number | nullish; /** * The layer name that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#layerName Read more...} */ layerName: string | nullish; /** * The value of the `foundFieldName` in the feature's attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#value Read more...} */ value: string | number | nullish; /** * The result from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-find.html find}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html Read more...} */ constructor(properties?: FindResultProperties); /** * The found feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#feature Read more...} */ get feature(): Graphic | nullish; set feature(value: GraphicProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FindResult; } interface FindResultProperties { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#displayFieldName Read more...} */ displayFieldName?: string | nullish; /** * The found feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#feature Read more...} */ feature?: GraphicProperties | nullish; /** * The name of the field that contains the search text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#foundFieldName Read more...} */ foundFieldName?: string | nullish; /** * Unique ID of the layer that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#layerId Read more...} */ layerId?: number | nullish; /** * The layer name that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#layerName Read more...} */ layerName?: string | nullish; /** * The value of the `foundFieldName` in the feature's attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FindResult.html#value Read more...} */ value?: string | number | nullish; } export interface FixedBoundariesBinParameters extends Accessor, JSONSupport, BinParametersBase { } export class FixedBoundariesBinParameters { /** * Array of values representing bin boundaries. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#boundaries Read more...} */ boundaries: number[] | Date[]; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expression Read more...} */ declare expression: BinParametersBase["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expressionValueType Read more...} */ declare expressionValueType: BinParametersBase["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#field Read more...} */ declare field: BinParametersBase["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#firstDayOfWeek Read more...} */ declare firstDayOfWeek: BinParametersBase["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#hideUpperBound Read more...} */ declare hideUpperBound: BinParametersBase["hideUpperBound"]; /** * The type of bin parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#type Read more...} */ readonly type: "fixed-boundaries"; /** * FixedBoundariesBinParameters specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html Read more...} */ constructor(properties?: FixedBoundariesBinParametersProperties); /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#splitBy Read more...} */ get splitBy(): AttributeBinsGrouping | nullish; set splitBy(value: AttributeBinsGroupingProperties | nullish); /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#stackBy Read more...} */ get stackBy(): AttributeBinsGrouping | nullish; set stackBy(value: AttributeBinsGroupingProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FixedBoundariesBinParameters; } interface FixedBoundariesBinParametersProperties extends BinParametersBaseProperties { /** * Array of values representing bin boundaries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#boundaries Read more...} */ boundaries?: number[] | Date[]; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expression Read more...} */ expression?: BinParametersBaseProperties["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#expressionValueType Read more...} */ expressionValueType?: BinParametersBaseProperties["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#field Read more...} */ field?: BinParametersBaseProperties["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#firstDayOfWeek Read more...} */ firstDayOfWeek?: BinParametersBaseProperties["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#hideUpperBound Read more...} */ hideUpperBound?: BinParametersBaseProperties["hideUpperBound"]; /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#splitBy Read more...} */ splitBy?: AttributeBinsGroupingProperties | nullish; /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedBoundariesBinParameters.html#stackBy Read more...} */ stackBy?: AttributeBinsGroupingProperties | nullish; } export interface FixedIntervalBinParameters extends Accessor, JSONSupport, BinParametersBase, NormalizationBinParametersMixin { } export class FixedIntervalBinParameters { /** * The end value of bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#end Read more...} */ end: number | Date | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expression Read more...} */ declare expression: BinParametersBase["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expressionValueType Read more...} */ declare expressionValueType: BinParametersBase["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#field Read more...} */ declare field: BinParametersBase["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#firstDayOfWeek Read more...} */ declare firstDayOfWeek: BinParametersBase["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#hideUpperBound Read more...} */ declare hideUpperBound: BinParametersBase["hideUpperBound"]; /** * Represents the interval of values to be included in each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#interval Read more...} */ interval: number; /** * Name of the numeric field used to normalize values during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationField Read more...} */ declare normalizationField: NormalizationBinParametersMixin["normalizationField"]; /** * The maximum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationMaxValue Read more...} */ declare normalizationMaxValue: NormalizationBinParametersMixin["normalizationMaxValue"]; /** * The minimum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationMinValue Read more...} */ declare normalizationMinValue: NormalizationBinParametersMixin["normalizationMinValue"]; /** * The total value used when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationType normalizationType} is `percent-of-total`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationTotal Read more...} */ declare normalizationTotal: NormalizationBinParametersMixin["normalizationTotal"]; /** * Normalization type used to normalize data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationType Read more...} */ declare normalizationType: NormalizationBinParametersMixin["normalizationType"]; /** * The start value of bins to generate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#start Read more...} */ start: number | Date | nullish; /** * The type of bin parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#type Read more...} */ readonly type: "fixed-interval"; /** * FixedIntervalBinParameters specifies {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html Read more...} */ constructor(properties?: FixedIntervalBinParametersProperties); /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#splitBy Read more...} */ get splitBy(): AttributeBinsGrouping | nullish; set splitBy(value: AttributeBinsGroupingProperties | nullish); /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#stackBy Read more...} */ get stackBy(): AttributeBinsGrouping | nullish; set stackBy(value: AttributeBinsGroupingProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FixedIntervalBinParameters; } interface FixedIntervalBinParametersProperties extends BinParametersBaseProperties, NormalizationBinParametersMixinProperties { /** * The end value of bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#end Read more...} */ end?: number | Date | nullish; /** * A standardized SQL expression used to calculate the bins, rather than referencing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#field field}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expression Read more...} */ expression?: BinParametersBaseProperties["expression"]; /** * Specifies the expected data type of the output from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expression expression}, based on the type of value the expression generates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#expressionValueType Read more...} */ expressionValueType?: BinParametersBaseProperties["expressionValueType"]; /** * The field name used to calculate the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#field Read more...} */ field?: BinParametersBaseProperties["field"]; /** * The first day of the week. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#firstDayOfWeek Read more...} */ firstDayOfWeek?: BinParametersBaseProperties["firstDayOfWeek"]; /** * If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#hideUpperBound Read more...} */ hideUpperBound?: BinParametersBaseProperties["hideUpperBound"]; /** * Represents the interval of values to be included in each bin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#interval Read more...} */ interval?: number; /** * Name of the numeric field used to normalize values during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationField Read more...} */ normalizationField?: NormalizationBinParametersMixinProperties["normalizationField"]; /** * The maximum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationMaxValue Read more...} */ normalizationMaxValue?: NormalizationBinParametersMixinProperties["normalizationMaxValue"]; /** * The minimum value used to normalize the data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationMinValue Read more...} */ normalizationMinValue?: NormalizationBinParametersMixinProperties["normalizationMinValue"]; /** * The total value used when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationType normalizationType} is `percent-of-total`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationTotal Read more...} */ normalizationTotal?: NormalizationBinParametersMixinProperties["normalizationTotal"]; /** * Normalization type used to normalize data during binning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#normalizationType Read more...} */ normalizationType?: NormalizationBinParametersMixinProperties["normalizationType"]; /** * The `splitBy` parameter divides data into separate bins for each unique value in the categorical field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#splitBy Read more...} */ splitBy?: AttributeBinsGroupingProperties | nullish; /** * The `stackBy` parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin * while keeping the bin boundaries consistent across all categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#stackBy Read more...} */ stackBy?: AttributeBinsGroupingProperties | nullish; /** * The start value of bins to generate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FixedIntervalBinParameters.html#start Read more...} */ start?: number | Date | nullish; } export interface GeneralizeParameters extends Accessor, JSONSupport { } export class GeneralizeParameters { /** * The maximum deviation unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#deviationUnit Read more...} */ deviationUnit: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "decimal-degrees" | nullish; /** * The array of input geometries to generalize. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#geometries Read more...} */ geometries: GeometryUnion[] | nullish; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#maxDeviation Read more...} */ maxDeviation: number | nullish; /** * Sets the geometries, maximum deviation and units for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#generalize generalize} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html Read more...} */ constructor(properties?: GeneralizeParametersProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GeneralizeParameters; } interface GeneralizeParametersProperties { /** * The maximum deviation unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#deviationUnit Read more...} */ deviationUnit?: | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "decimal-degrees" | nullish; /** * The array of input geometries to generalize. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#geometries Read more...} */ geometries?: GeometryUnion[] | nullish; /** * The maximum deviation for constructing a generalized geometry based on the input geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GeneralizeParameters.html#maxDeviation Read more...} */ maxDeviation?: number | nullish; } export interface GPMessage extends Accessor, JSONSupport { } export class GPMessage { /** * The geoprocessing message. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#description Read more...} */ description: string | nullish; /** * The geoprocessing message type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#type Read more...} */ type: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort" | nullish; /** * Represents a message generated during the execution of a module:geoscene/rest/Geoprocessor method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html Read more...} */ constructor(properties?: GPMessageProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GPMessage; } interface GPMessageProperties { /** * The geoprocessing message. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#description Read more...} */ description?: string | nullish; /** * The geoprocessing message type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-GPMessage.html#type Read more...} */ type?: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort" | nullish; } export interface IdentifyParameters extends Accessor, JSONSupport { } export class IdentifyParameters { /** * Resolution of the current map view in dots per inch. * * @default 96 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#dpi Read more...} */ dpi: number; /** * Specify the geodatabase version to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Specify the number of decimal places for the geometries returned by the task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * Height of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} in pixels. * * @default 400 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#height Read more...} */ height: number; /** * The layers on which to perform the identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#layerIds Read more...} */ layerIds: number[] | nullish; /** * Specifies which layers to use when using Identify. * * @default "top" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#layerOption Read more...} */ layerOption: "top" | "visible" | "all" | "popup"; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#maxAllowableOffset Read more...} */ maxAllowableOffset: number | nullish; /** * If `true`, field names will be returned instead of field aliases. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnFieldName Read more...} */ returnFieldName: boolean; /** * If `true`, the result set includes the geometry associated with each result. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * When `true`, indicates that M values will be returned. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnM Read more...} */ returnM: boolean; /** * If `true`, the values in the result will not be formatted i.e. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnUnformattedValues Read more...} */ returnUnformattedValues: boolean; /** * When `true`, indicates that z-values will be returned. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnZ Read more...} */ returnZ: boolean; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#tolerance Read more...} */ tolerance: number | nullish; /** * Width of the current map view in pixels. * * @default 400 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#width Read more...} */ width: number; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-identify.html identify}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html Read more...} */ constructor(properties?: IdentifyParametersProperties); /** * The geometry used to select features during the Identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The historic moment to identify. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The Extent or bounding box of the current map view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#mapExtent Read more...} */ get mapExtent(): Extent | nullish; set mapExtent(value: ExtentProperties | nullish); /** * The spatial reference of the input and output geometries as well as of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#mapExtent mapExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * An [Collection](geoscene-core-Collection.html) of [Sublayer](geoscene-layers-support-Sublayer.html) * objects used to change the layer ordering and/or rendering, or redefine the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#sublayers Read more...} */ get sublayers(): Collection | nullish; set sublayers(value: CollectionProperties | nullish); /** * Specify the time extent used by identify. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): IdentifyParameters; } interface IdentifyParametersProperties { /** * Resolution of the current map view in dots per inch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#dpi Read more...} */ dpi?: number; /** * Specify the geodatabase version to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The geometry used to select features during the Identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * Specify the number of decimal places for the geometries returned by the task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * Height of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#height Read more...} */ height?: number; /** * The historic moment to identify. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The layers on which to perform the identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#layerIds Read more...} */ layerIds?: number[] | nullish; /** * Specifies which layers to use when using Identify. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#layerOption Read more...} */ layerOption?: "top" | "visible" | "all" | "popup"; /** * The Extent or bounding box of the current map view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#mapExtent Read more...} */ mapExtent?: ExtentProperties | nullish; /** * The maximum allowable offset used for generalizing geometries returned by the identify operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#maxAllowableOffset Read more...} */ maxAllowableOffset?: number | nullish; /** * If `true`, field names will be returned instead of field aliases. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnFieldName Read more...} */ returnFieldName?: boolean; /** * If `true`, the result set includes the geometry associated with each result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * When `true`, indicates that M values will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnM Read more...} */ returnM?: boolean; /** * If `true`, the values in the result will not be formatted i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnUnformattedValues Read more...} */ returnUnformattedValues?: boolean; /** * When `true`, indicates that z-values will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#returnZ Read more...} */ returnZ?: boolean; /** * The spatial reference of the input and output geometries as well as of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#mapExtent mapExtent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * An [Collection](geoscene-core-Collection.html) of [Sublayer](geoscene-layers-support-Sublayer.html) * objects used to change the layer ordering and/or rendering, or redefine the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#sublayers Read more...} */ sublayers?: CollectionProperties | nullish; /** * Specify the time extent used by identify. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The distance in screen pixels from the specified geometry within which the identify should be performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#tolerance Read more...} */ tolerance?: number | nullish; /** * Width of the current map view in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyParameters.html#width Read more...} */ width?: number; } export interface IdentifyResult extends Accessor, JSONSupport { } export class IdentifyResult { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#displayFieldName Read more...} */ displayFieldName: string; /** * Unique ID of the layer that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#layerId Read more...} */ layerId: number; /** * The layer name that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#layerName Read more...} */ layerName: string; /** * The result from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-identify.html identify}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html Read more...} */ constructor(properties?: IdentifyResultProperties); /** * An identified feature from the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#feature Read more...} */ get feature(): Graphic; set feature(value: GraphicProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): IdentifyResult; } interface IdentifyResultProperties { /** * The name of the layer's primary display field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#displayFieldName Read more...} */ displayFieldName?: string; /** * An identified feature from the map service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#feature Read more...} */ feature?: GraphicProperties; /** * Unique ID of the layer that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#layerId Read more...} */ layerId?: number; /** * The layer name that contains the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-IdentifyResult.html#layerName Read more...} */ layerName?: string; } export interface ImageAngleParameters extends Accessor, JSONSupport { } export class ImageAngleParameters { /** * Angle names to be computed. * * @default ["north","up"] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#angleNames Read more...} */ angleNames: string[] | nullish; /** * The rasterId of a raster catalog in the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#rasterId Read more...} */ rasterId: number | nullish; /** * Input parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeAngles ImageryLayer.computeAngles()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computeAngles imageService.computeAngles()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html Read more...} */ constructor(properties?: ImageAngleParametersProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry that defines the reference point of rotation to * compute the angle direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#point Read more...} */ get point(): Point | nullish; set point(value: PointProperties | nullish); /** * The spatial reference used to compute the angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageAngleParameters; } interface ImageAngleParametersProperties { /** * Angle names to be computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#angleNames Read more...} */ angleNames?: string[] | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry that defines the reference point of rotation to * compute the angle direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#point Read more...} */ point?: PointProperties | nullish; /** * The rasterId of a raster catalog in the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#rasterId Read more...} */ rasterId?: number | nullish; /** * The spatial reference used to compute the angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleParameters.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#north Read more...} */ north: number | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#up Read more...} */ up: number | nullish; /** * The results from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computeAngles imageService.computeAngles()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeAngles ImageryLayer.computeAngles()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html Read more...} */ constructor(properties?: ImageAngleResultProperties); /** * The spatial reference used to compute the angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#north Read more...} */ north?: number | nullish; /** * The spatial reference used to compute the angles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAngleResult.html#up Read more...} */ up?: number | nullish; } export class ImageAreaParameters extends BaseImageMeasureParameters { /** * The area unit used for an area calculation. * * @default "square-meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#areaUnit Read more...} */ 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"; /** * When `true`, this method calculates the 3D measurements for the area and perimeter of a given geometry on an image service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#is3D Read more...} */ is3D: boolean; /** * Linear unit used for a perimeter calculation. * * @default "meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#linearUnit Read more...} */ linearUnit: LengthUnit | "decimal-degrees" | "points" | "unknown"; /** * The string value representing the type of imagery mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#type Read more...} */ readonly type: "area-perimeter"; /** * Input parameters used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaAndPerimeter ImageryLayer.measureAreaAndPerimeter()} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaAndPerimeter imageService.measureAreaAndPerimeter()} methods to perform imagery * area and perimeter mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html Read more...} */ constructor(properties?: ImageAreaParametersProperties); /** * The extent or polygon geometry used to perform the area and perimeter measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#geometry Read more...} */ get geometry(): Extent | Polygon; set geometry(value: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" })); static fromJSON(json: any): ImageAreaParameters; } interface ImageAreaParametersProperties extends BaseImageMeasureParametersProperties { /** * The area unit used for an area calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#areaUnit Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#geometry Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#is3D Read more...} */ is3D?: boolean; /** * Linear unit used for a perimeter calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaParameters.html#linearUnit Read more...} */ linearUnit?: LengthUnit | "decimal-degrees" | "points" | "unknown"; } export class ImageAreaResult extends BaseImageMeasureResult { /** * Image service area and perimeter measurement result returned when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaAndPerimeter ImageryLayer.measureAreaAndPerimeter()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaAndPerimeter imageService.measureAreaAndPerimeter()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaResult.html Read more...} */ constructor(properties?: ImageAreaResultProperties); /** * An object containing results of the area measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaResult.html#area Read more...} */ get area(): MeasurementValue; set area(value: MeasurementValueProperties); /** * An object containing results of the perimeter measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaResult.html#perimeter Read more...} */ get perimeter(): MeasurementValue; set perimeter(value: MeasurementValueProperties); static fromJSON(json: any): ImageAreaResult; } interface ImageAreaResultProperties extends BaseImageMeasureResultProperties { /** * An object containing results of the area measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaResult.html#area Read more...} */ area?: MeasurementValueProperties; /** * An object containing results of the perimeter measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageAreaResult.html#perimeter Read more...} */ perimeter?: MeasurementValueProperties; } export interface ImageBoundaryParameters extends Accessor, JSONSupport { } export class ImageBoundaryParameters { /** * Image boundary query parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryBoundary ImageryLayer.queryBoundary()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryBoundary imageService.queryBoundary()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html Read more...} */ constructor(properties?: ImageBoundaryParametersProperties); /** * The spatial reference for the output boundary geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageBoundaryParameters; } interface ImageBoundaryParametersProperties { /** * The spatial reference for the output boundary geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; } export interface ImageBoundaryResult extends Accessor, JSONSupport { } export class ImageBoundaryResult { /** * The area of the boundary geometry in square meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#area Read more...} */ area: number; /** * Image boundary query result for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryBoundary ImageryLayer.queryBoundary()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryBoundary imageService.queryBoundary()} methods containing boundary geometry of an image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html Read more...} */ constructor(properties?: ImageBoundaryResultProperties); /** * The geometry that defines the boundary of the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#geometry Read more...} */ get geometry(): Polygon | Extent; set geometry(value: (PolygonProperties & { type: "polygon" }) | (ExtentProperties & { type: "extent" })); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageBoundaryResult; } interface ImageBoundaryResultProperties { /** * The area of the boundary geometry in square meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#area Read more...} */ area?: number; /** * The geometry that defines the boundary of the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageBoundaryResult.html#geometry Read more...} */ geometry?: (PolygonProperties & { type: "polygon" }) | (ExtentProperties & { type: "extent" }); } export class ImageDistanceParameters extends BaseImageMeasureParameters { /** * The angular unit used for angle calculation. * * @default "degrees" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#angularUnit Read more...} */ angularUnit: "degrees" | "radians"; /** * When `true`, this method calculates the 3D measurements for the distance and angle between two points on an image service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#is3D Read more...} */ is3D: boolean; /** * The linear unit used for distance calculation. * * @default "meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#linearUnit Read more...} */ linearUnit: LengthUnit; /** * The string value representing the type of imagery mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#type Read more...} */ readonly type: "distance-angle"; /** * Input parameters used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureDistanceAndAngle ImageryLayer.measureDistanceAndAngle()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureDistanceAndAngle imageService.measureDistanceAndAngle()} methods to perform imagery * distance and angle mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html Read more...} */ constructor(properties?: ImageDistanceParametersProperties); /** * A point that defines the from location of the distance and angle measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#fromGeometry Read more...} */ get fromGeometry(): Point; set fromGeometry(value: PointProperties); /** * A point that defines the to location of the distance and angle measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#toGeometry Read more...} */ get toGeometry(): Point; set toGeometry(value: PointProperties); static fromJSON(json: any): ImageDistanceParameters; } interface ImageDistanceParametersProperties extends BaseImageMeasureParametersProperties { /** * The angular unit used for angle calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#angularUnit Read more...} */ angularUnit?: "degrees" | "radians"; /** * A point that defines the from location of the distance and angle measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#fromGeometry Read more...} */ fromGeometry?: PointProperties; /** * When `true`, this method calculates the 3D measurements for the distance and angle between two points on an image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#is3D Read more...} */ is3D?: boolean; /** * The linear unit used for distance calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#linearUnit Read more...} */ linearUnit?: LengthUnit; /** * A point that defines the to location of the distance and angle measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceParameters.html#toGeometry Read more...} */ toGeometry?: PointProperties; } export class ImageDistanceResult extends BaseImageMeasureResult { /** * Image service distance and angle measurement result returned when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureDistanceAndAngle ImageryLayer.measureDistanceAndAngle()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureDistanceAndAngle imageService.measureDistanceAndAngle()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html Read more...} */ constructor(properties?: ImageDistanceResultProperties); /** * An object containing the azimuth angle measurement values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#azimuthAngle Read more...} */ get azimuthAngle(): MeasurementValue; set azimuthAngle(value: MeasurementValueProperties); /** * An object containing results of the distance measurement between two points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#distance Read more...} */ get distance(): MeasurementValue; set distance(value: MeasurementValueProperties); /** * An object containing elevation angle measurement values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#elevationAngle Read more...} */ get elevationAngle(): MeasurementValue | nullish; set elevationAngle(value: MeasurementValueProperties | nullish); static fromJSON(json: any): ImageDistanceResult; } interface ImageDistanceResultProperties extends BaseImageMeasureResultProperties { /** * An object containing the azimuth angle measurement values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#azimuthAngle Read more...} */ azimuthAngle?: MeasurementValueProperties; /** * An object containing results of the distance measurement between two points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#distance Read more...} */ distance?: MeasurementValueProperties; /** * An object containing elevation angle measurement values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageDistanceResult.html#elevationAngle Read more...} */ elevationAngle?: MeasurementValueProperties | nullish; } export class ImageGPSInfo extends JSONSupport { /** * Image's camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#cameraID Read more...} */ cameraID: string; /** * Image's GPS location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#gps Read more...} */ gps: any; /** * Image id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#id Read more...} */ id: number; /** * Image name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#name Read more...} */ name: string; /** * Image's orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#orientation Read more...} */ orientation: any; /** * Image GPS information for images returned as a result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryGPSInfo ImageryLayer.queryGPSInfo()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryGPSInfo imageService.queryGPSInfo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html Read more...} */ constructor(properties?: ImageGPSInfoProperties); /** * Image acquisition date represented using Linux Epoch time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#acquisitionDate Read more...} */ get acquisitionDate(): Date | nullish; set acquisitionDate(value: DateProperties | nullish); /** * Image's center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#center Read more...} */ get center(): Point; set center(value: PointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageGPSInfo; } interface ImageGPSInfoProperties { /** * Image acquisition date represented using Linux Epoch time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#acquisitionDate Read more...} */ acquisitionDate?: DateProperties | nullish; /** * Image's camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#cameraID Read more...} */ cameraID?: string; /** * Image's center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#center Read more...} */ center?: PointProperties; /** * Image's GPS location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#gps Read more...} */ gps?: any; /** * Image id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#id Read more...} */ id?: number; /** * Image name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#name Read more...} */ name?: string; /** * Image's orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfo.html#orientation Read more...} */ orientation?: any; } export class ImageGPSInfoParameters extends JSONSupport { /** * An array of ObjectIDs to be used to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#objectIds Read more...} */ objectIds: (number | string)[] | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query image footprints * in the layer against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#geometry geometry}. * * @default "intersects" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#spatialRelationship Read more...} */ spatialRelationship: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#where Read more...} */ where: string | nullish; /** * Image GPS info parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryGPSInfo ImageryLayer.queryGPSInfo()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryGPSInfo imageService.queryGPSInfo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html Read more...} */ constructor(properties?: ImageGPSInfoParametersProperties); /** * The geometry to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#geometry Read more...} */ get geometry(): Extent | Multipoint | Point | Polygon | Polyline | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | nullish); /** * A time extent for a temporal query to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageGPSInfoParameters; } interface ImageGPSInfoParametersProperties { /** * The geometry to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | nullish; /** * An array of ObjectIDs to be used to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#objectIds Read more...} */ objectIds?: (number | string)[] | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query image footprints * in the layer against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#spatialRelationship Read more...} */ spatialRelationship?: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; /** * A time extent for a temporal query to query images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoParameters.html#where Read more...} */ where?: string | nullish; } export class ImageGPSInfoResult extends JSONSupport { /** * Result for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#queryGPSInfo ImageryLayer.queryGPSInfo()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#queryGPSInfo imageService.queryGPSInfo()} methods containing camera and image GPS information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html Read more...} */ constructor(properties?: ImageGPSInfoResultProperties); /** * An array of camera information for the queried images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#cameras Read more...} */ get cameras(): CameraInfo[]; set cameras(value: CameraInfoProperties[]); /** * An array of GPS information for the queried images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#images Read more...} */ get images(): ImageGPSInfo[]; set images(value: ImageGPSInfoProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageGPSInfoResult; } interface ImageGPSInfoResultProperties { /** * An array of camera information for the queried images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#cameras Read more...} */ cameras?: CameraInfoProperties[]; /** * An array of GPS information for the queried images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageGPSInfoResult.html#images Read more...} */ images?: ImageGPSInfoProperties[]; } export class ImageHeightParameters extends BaseImageMeasureParameters { /** * Linear unit used for height calculation. * * @default "meters" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#linearUnit Read more...} */ linearUnit: LengthUnit; /** * Determines how the height will be measured when the sensor info is available. * * @default "base-and-top" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#operationType Read more...} */ operationType: "base-and-top" | "base-and-top-shadow" | "top-and-top-shadow"; /** * The string value representing the type of imagery mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#type Read more...} */ readonly type: "height"; /** * Input parameters used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureHeight ImageryLayer.measureHeight()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureHeight imageService.measureHeight()} methods to perform imagery * height mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html Read more...} */ constructor(properties?: ImageHeightParametersProperties); /** * A point that defines the from location of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#fromGeometry Read more...} */ get fromGeometry(): Point; set fromGeometry(value: PointProperties); /** * A point that defines the to location of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#toGeometry Read more...} */ get toGeometry(): Point; set toGeometry(value: PointProperties); static fromJSON(json: any): ImageHeightParameters; } interface ImageHeightParametersProperties extends BaseImageMeasureParametersProperties { /** * A point that defines the from location of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#fromGeometry Read more...} */ fromGeometry?: PointProperties; /** * Linear unit used for height calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#linearUnit Read more...} */ linearUnit?: LengthUnit; /** * Determines how the height will be measured when the sensor info is available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#operationType Read more...} */ operationType?: "base-and-top" | "base-and-top-shadow" | "top-and-top-shadow"; /** * A point that defines the to location of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightParameters.html#toGeometry Read more...} */ toGeometry?: PointProperties; } export class ImageHeightResult extends BaseImageMeasureResult { /** * Image service height mensuration result returned when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureHeight ImageryLayer.measureHeight()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureHeight imageService.measureHeight()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightResult.html Read more...} */ constructor(properties?: ImageHeightResultProperties); /** * An object containing results of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightResult.html#height Read more...} */ get height(): MeasurementValue; set height(value: MeasurementValueProperties); static fromJSON(json: any): ImageHeightResult; } interface ImageHeightResultProperties extends BaseImageMeasureResultProperties { /** * An object containing results of the height measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHeightResult.html#height Read more...} */ height?: MeasurementValueProperties; } export interface ImageHistogramParameters extends Accessor, JSONSupport { } export class ImageHistogramParameters { /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeHistograms computeHistograms} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computeStatisticsHistograms computeStatisticsHistograms} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html#computeStatisticsHistograms computeStatisticsHistograms} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html Read more...} */ constructor(properties?: ImageHistogramParametersProperties); /** * Input geometry that defines the area of interest for which the histograms and statistics will be computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#geometry Read more...} */ get geometry(): Extent | Polygon | nullish; set geometry(value: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the histogram is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule | nullish; set mosaicRule(value: MosaicRuleProperties | nullish); /** * Specifies the pixel size (or the resolution). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#pixelSize Read more...} */ get pixelSize(): Point; set pixelSize(value: PointProperties); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html raster function} from which to compute the statistics and histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#rasterFunction Read more...} */ get rasterFunction(): RasterFunction | nullish; set rasterFunction(value: RasterFunctionProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} for which to compute the statistics and histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageHistogramParameters; } interface ImageHistogramParametersProperties { /** * Input geometry that defines the area of interest for which the histograms and statistics will be computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#geometry Read more...} */ geometry?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the histogram is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties | nullish; /** * Specifies the pixel size (or the resolution). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#pixelSize Read more...} */ pixelSize?: PointProperties; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RasterFunction.html raster function} from which to compute the statistics and histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#rasterFunction Read more...} */ rasterFunction?: RasterFunctionProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} for which to compute the statistics and histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageHistogramParameters.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; } export interface ImageIdentifyParameters extends Accessor, JSONSupport { } export class ImageIdentifyParameters { /** * Controls the maximum number of returned catalog items, set to 1 to return * the top most raster only. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#maxItemCount Read more...} */ maxItemCount: number | nullish; /** * When `true`, the request is processed for all variables and dimensions. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#processAsMultidimensional Read more...} */ processAsMultidimensional: boolean; /** * If `true`, returns both geometry and attributes of the catalog items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnCatalogItems Read more...} */ returnCatalogItems: boolean; /** * When `true`, each feature in the catalog items includes the geometry. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * If `true`, the pixel values of all raster catalog items under the requested geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnPixelValues Read more...} */ returnPixelValues: boolean; /** * Input parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html imageService}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html Read more...} */ constructor(properties?: ImageIdentifyParametersProperties); /** * Input geometry that defines the location to be identified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#geometry Read more...} */ get geometry(): Point | Polygon | Extent; set geometry(value: | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (ExtentProperties & { type: "extent" })); /** * Specifies the mosaic rules defining the image sorting order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule | nullish; set mosaicRule(value: MosaicRuleProperties | nullish); /** * Specifies the pixel level being identified on the x and y axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#pixelSize Read more...} */ get pixelSize(): Point | nullish; set pixelSize(value: PointProperties | nullish); /** * Specifies the raster function for how the requested image should be processed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunction Read more...} */ get rasterFunction(): RasterFunction | nullish; set rasterFunction(value: RasterFunctionProperties | nullish); /** * An array the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunction raster functions} to retrieve multiple processed pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunctions Read more...} */ get rasterFunctions(): RasterFunction[] | nullish; set rasterFunctions(value: RasterFunctionProperties[] | nullish); /** * A time extent for a temporal data against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeInfo time-aware imagery layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageIdentifyParameters; } interface ImageIdentifyParametersProperties { /** * Input geometry that defines the location to be identified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#geometry Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#maxItemCount Read more...} */ maxItemCount?: number | nullish; /** * Specifies the mosaic rules defining the image sorting order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties | nullish; /** * Specifies the pixel level being identified on the x and y axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#pixelSize Read more...} */ pixelSize?: PointProperties | nullish; /** * When `true`, the request is processed for all variables and dimensions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#processAsMultidimensional Read more...} */ processAsMultidimensional?: boolean; /** * Specifies the raster function for how the requested image should be processed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunction Read more...} */ rasterFunction?: RasterFunctionProperties | nullish; /** * An array the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunction raster functions} to retrieve multiple processed pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#rasterFunctions Read more...} */ rasterFunctions?: RasterFunctionProperties[] | nullish; /** * If `true`, returns both geometry and attributes of the catalog items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnCatalogItems Read more...} */ returnCatalogItems?: boolean; /** * When `true`, each feature in the catalog items includes the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * If `true`, the pixel values of all raster catalog items under the requested geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#returnPixelValues Read more...} */ returnPixelValues?: boolean; /** * A time extent for a temporal data against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#timeInfo time-aware imagery layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyParameters.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; } export interface ImageIdentifyResult extends Accessor, JSONSupport { } export class ImageIdentifyResult { /** * The set of visible areas for the identified catalog items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#catalogItemVisibilities Read more...} */ catalogItemVisibilities: number[] | nullish; /** * The identify property name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#name Read more...} */ name: string | nullish; /** * The identify property id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#objectId Read more...} */ objectId: number | nullish; /** * The attributes of the identified object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#properties Read more...} */ properties: any | nullish; /** * The identify image service pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#value Read more...} */ value: string | nullish; /** * The results from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html imageService}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html Read more...} */ constructor(properties?: ImageIdentifyResultProperties); /** * The set of catalog items that overlap the input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#catalogItems Read more...} */ get catalogItems(): FeatureSet | nullish; set catalogItems(value: FeatureSetProperties | nullish); /** * The identified location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#location Read more...} */ get location(): Point; set location(value: PointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageIdentifyResult; } interface ImageIdentifyResultProperties { /** * The set of catalog items that overlap the input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#catalogItems Read more...} */ catalogItems?: FeatureSetProperties | nullish; /** * The set of visible areas for the identified catalog items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#catalogItemVisibilities Read more...} */ catalogItemVisibilities?: number[] | nullish; /** * The identified location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#location Read more...} */ location?: PointProperties; /** * The identify property name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#name Read more...} */ name?: string | nullish; /** * The identify property id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#objectId Read more...} */ objectId?: number | nullish; /** * The attributes of the identified object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#properties Read more...} */ properties?: any | nullish; /** * The identify image service pixel value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageIdentifyResult.html#value Read more...} */ value?: string | nullish; } export class ImageInspectionInfo extends JSONSupport { /** * Image's camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#cameraID Read more...} */ cameraID: string; /** * Camera's columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#cols Read more...} */ cols: number; /** * Camera's focal length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#focalLength Read more...} */ focalLength: number | nullish; /** * Image id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#id Read more...} */ id: number; /** * Camera's manufacturer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#make Read more...} */ make: string; /** * Camera's model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#model Read more...} */ model: string; /** * Image's orientation along x, y, z axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#orientation Read more...} */ orientation: ImageInspectionInfoOrientation; /** * Camera's pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#pixelSize Read more...} */ pixelSize: number | nullish; /** * The relative reference to the image's uri. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#referenceUri Read more...} */ referenceUri: string; /** * Camera's rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#rows Read more...} */ rows: number; /** * Image information for images returned as a result of running {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#findImages ImageryLayer.findImages()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#findImages imageService.findImages()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html Read more...} */ constructor(properties?: ImageInspectionInfoProperties); /** * Image acquisition date represented in Linux Epoch time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#acquisitionDate Read more...} */ get acquisitionDate(): Date | nullish; set acquisitionDate(value: DateProperties | nullish); /** * Image's center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#center Read more...} */ get center(): Point; set center(value: PointProperties); /** * Perspective center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#perspectiveCenter Read more...} */ get perspectiveCenter(): Point | nullish; set perspectiveCenter(value: PointProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageInspectionInfo; } interface ImageInspectionInfoProperties { /** * Image acquisition date represented in Linux Epoch time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#acquisitionDate Read more...} */ acquisitionDate?: DateProperties | nullish; /** * Image's camera id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#cameraID Read more...} */ cameraID?: string; /** * Image's center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#center Read more...} */ center?: PointProperties; /** * Camera's columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#cols Read more...} */ cols?: number; /** * Camera's focal length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#focalLength Read more...} */ focalLength?: number | nullish; /** * Image id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#id Read more...} */ id?: number; /** * Camera's manufacturer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#make Read more...} */ make?: string; /** * Camera's model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#model Read more...} */ model?: string; /** * Image's orientation along x, y, z axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#orientation Read more...} */ orientation?: ImageInspectionInfoOrientation; /** * Perspective center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#perspectiveCenter Read more...} */ perspectiveCenter?: PointProperties | nullish; /** * Camera's pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#pixelSize Read more...} */ pixelSize?: number | nullish; /** * The relative reference to the image's uri. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#referenceUri Read more...} */ referenceUri?: string; /** * Camera's rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageInspectionInfo.html#rows Read more...} */ rows?: number; } export interface ImageInspectionInfoOrientation { omega: number; phi: number; kappa: number; clockwise: boolean; } export class ImageParameters extends Accessor { /** * Dots per inch setting for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultMapImageLayer JobInfo.fetchResultMapImageLayer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#dpi Read more...} */ dpi: number | nullish; /** * Map image format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#format Read more...} */ format: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg" | nullish; /** * Requested image height in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#height Read more...} */ height: number | nullish; /** * Array of layer definition expressions that allows you to filter the features of individual * layers in the exported map image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerDefinitions Read more...} */ layerDefinitions: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerIds Read more...} */ layerIds: number[] | nullish; /** * This property determines how the layers specified by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerIds layerIds} are treated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerOption Read more...} */ layerOption: "show" | "hide" | "include" | "exclude" | nullish; /** * Indicates whether or not the background of the dynamic image is transparent. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#transparent Read more...} */ transparent: boolean; /** * Requested image width in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#width Read more...} */ width: number | nullish; /** * Represents the image parameter options used when calling * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultImage JobInfo.fetchResultImage()} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultMapImageLayer JobInfo.fetchResultMapImageLayer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html Read more...} */ constructor(properties?: ImageParametersProperties); /** * Extent of map to be exported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * Spatial reference of exported image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#imageSpatialReference Read more...} */ get imageSpatialReference(): SpatialReference | nullish; set imageSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its GeoScene portal JSON representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#toJSON Read more...} */ toJSON(): any; } interface ImageParametersProperties { /** * Dots per inch setting for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultMapImageLayer JobInfo.fetchResultMapImageLayer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#dpi Read more...} */ dpi?: number | nullish; /** * Extent of map to be exported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * Map image format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#format Read more...} */ format?: "png" | "png8" | "png24" | "png32" | "jpg" | "pdf" | "bmp" | "gif" | "svg" | nullish; /** * Requested image height in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#height Read more...} */ height?: number | nullish; /** * Spatial reference of exported image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#imageSpatialReference Read more...} */ imageSpatialReference?: SpatialReferenceProperties | nullish; /** * Array of layer definition expressions that allows you to filter the features of individual * layers in the exported map image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerDefinitions Read more...} */ layerDefinitions?: string[]; /** * A list of layer IDs, that represent which layers to include in the exported map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerIds Read more...} */ layerIds?: number[] | nullish; /** * This property determines how the layers specified by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerIds layerIds} are treated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#layerOption Read more...} */ layerOption?: "show" | "hide" | "include" | "exclude" | nullish; /** * Indicates whether or not the background of the dynamic image is transparent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#transparent Read more...} */ transparent?: boolean; /** * Requested image width in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageParameters.html#width Read more...} */ width?: number | nullish; } export interface ImagePixelLocationParameters extends Accessor, JSONSupport { } export class ImagePixelLocationParameters { /** * The rasterId of a raster catalog in the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#rasterId Read more...} */ rasterId: number | nullish; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computePixelSpaceLocations ImageryLayer.computePixelSpaceLocations()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computePixelSpaceLocations imageService.computePixelSpaceLocations()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html Read more...} */ constructor(properties?: ImagePixelLocationParametersProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html points} that defines pixel locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#geometries Read more...} */ get geometries(): Point[]; set geometries(value: PointProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImagePixelLocationParameters; } interface ImagePixelLocationParametersProperties { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html points} that defines pixel locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#geometries Read more...} */ geometries?: PointProperties[]; /** * The rasterId of a raster catalog in the image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationParameters.html#rasterId Read more...} */ rasterId?: number | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationResult.html#geometries Read more...} */ geometries: any[] | nullish; /** * The results from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#computePixelSpaceLocations imageService.computePixelSpaceLocations()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#computePixelSpaceLocations ImageryLayer.computePixelSpaceLocations()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationResult.html Read more...} */ constructor(properties?: ImagePixelLocationResultProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePixelLocationResult.html#geometries Read more...} */ geometries?: any[] | nullish; } export class ImagePointParameters extends BaseImageMeasureParameters { /** * When `true`, this method calculates the z-value for the returned point geometry. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html#is3D Read more...} */ is3D: boolean; /** * The string value representing the type of imagery mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html#type Read more...} */ readonly type: "point"; /** * Input parameters used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measurePointOrCentroid ImageryLayer.measurePointOrCentroid()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measurePointOrCentroid imageService.measurePointOrCentroid()} methods to perform imagery * point or centroid mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html Read more...} */ constructor(properties?: ImagePointParametersProperties); /** * Input geometry to determine a point location or a centroid of a given area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html#geometry Read more...} */ get geometry(): Point | Extent | Polygon; set geometry(value: | (PointProperties & { type: "point" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" })); static fromJSON(json: any): ImagePointParameters; } interface ImagePointParametersProperties extends BaseImageMeasureParametersProperties { /** * Input geometry to determine a point location or a centroid of a given area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html#geometry Read more...} */ geometry?: | (PointProperties & { type: "point" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * When `true`, this method calculates the z-value for the returned point geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointParameters.html#is3D Read more...} */ is3D?: boolean; } export class ImagePointResult extends BaseImageMeasureResult { /** * Image service point or centroid measurement result returned when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measurePointOrCentroid ImageryLayer.measurePointOrCentroid()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measurePointOrCentroid imageService.measurePointOrCentroid()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointResult.html Read more...} */ constructor(properties?: ImagePointResultProperties); /** * The measured point on an image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointResult.html#point Read more...} */ get point(): Point; set point(value: PointProperties); static fromJSON(json: any): ImagePointResult; } interface ImagePointResultProperties extends BaseImageMeasureResultProperties { /** * The measured point on an image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImagePointResult.html#point Read more...} */ point?: PointProperties; } export interface ImageSample extends Accessor, JSONSupport { } export class ImageSample { /** * Name-value pairs of fields and field values associated with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#location sample location}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#attributes Read more...} */ attributes: any | nullish; /** * The location id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#locationId Read more...} */ locationId: number; /** * The pixel value associated with the sampled location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#pixelValue Read more...} */ pixelValue: number[] | nullish; /** * The raster id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#rasterId Read more...} */ rasterId: number | nullish; /** * The resolution representing the average of source raster's resolutions in x and y axes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#resolution Read more...} */ resolution: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples getSamples} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} returns * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html ImageSampleResult} containing array of this class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html Read more...} */ constructor(properties?: ImageSampleProperties); /** * The sample location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#location Read more...} */ get location(): Point; set location(value: PointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageSample; } interface ImageSampleProperties { /** * Name-value pairs of fields and field values associated with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#location sample location}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#attributes Read more...} */ attributes?: any | nullish; /** * The sample location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#location Read more...} */ location?: PointProperties; /** * The location id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#locationId Read more...} */ locationId?: number; /** * The pixel value associated with the sampled location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#pixelValue Read more...} */ pixelValue?: number[] | nullish; /** * The raster id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#rasterId Read more...} */ rasterId?: number | nullish; /** * The resolution representing the average of source raster's resolutions in x and y axes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html#resolution Read more...} */ resolution?: number; } export interface ImageSampleParameters extends Accessor, JSONSupport { } export class ImageSampleParameters { /** * Defines how to interpolate pixel values. * * @default "nearest" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#interpolation Read more...} */ interpolation: "nearest" | "bilinear" | "cubic" | "majority"; /** * The list of fields associated with the rasters to be included in the response. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#outFields Read more...} */ outFields: string[] | nullish; /** * When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#returnFirstValueOnly Read more...} */ returnFirstValueOnly: boolean; /** * Specifies the approximate number of locations to sample from the provided geometry when the input geometry is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sampleCount Read more...} */ sampleCount: number | nullish; /** * Specifies the distance interval to sample points from the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry geometry} when input geometry is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sampleDistance Read more...} */ sampleDistance: number | nullish; /** * Specifies the slice id of a multidimensional raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sliceId Read more...} */ sliceId: number | nullish; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples getSamples()} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html Read more...} */ constructor(properties?: ImageSampleParametersProperties); /** * Input geometry that defines the locations to be sampled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry Read more...} */ get geometry(): Point | Multipoint | Polyline | Extent | Polygon; set geometry(value: | (PointProperties & { type: "point" }) | (MultipointProperties & { type: "multipoint" }) | (PolylineProperties & { type: "polyline" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" })); /** * When sampling multiple locations, you can use an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html points} instead of providing * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multipoint} for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry geometry} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#locations Read more...} */ get locations(): Point[] | nullish; set locations(value: PointProperties[] | nullish); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} defining the image sort order and selection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule | nullish; set mosaicRule(value: MosaicRuleProperties | nullish); /** * Specifies the pixel size (or the resolution) that will be used for the sampling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#pixelSize Read more...} */ get pixelSize(): Point | nullish; set pixelSize(value: PointProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} for which to perform sampling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageSampleParameters; } interface ImageSampleParametersProperties { /** * Input geometry that defines the locations to be sampled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry Read more...} */ geometry?: | (PointProperties & { type: "point" }) | (MultipointProperties & { type: "multipoint" }) | (PolylineProperties & { type: "polyline" }) | (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }); /** * Defines how to interpolate pixel values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#interpolation Read more...} */ interpolation?: "nearest" | "bilinear" | "cubic" | "majority"; /** * When sampling multiple locations, you can use an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html points} instead of providing * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multipoint} for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry geometry} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#locations Read more...} */ locations?: PointProperties[] | nullish; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} defining the image sort order and selection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties | nullish; /** * The list of fields associated with the rasters to be included in the response. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Specifies the pixel size (or the resolution) that will be used for the sampling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#pixelSize Read more...} */ pixelSize?: PointProperties | nullish; /** * When `true`, returns the first valid pixel value that meets specified conditions at each sampling point location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#returnFirstValueOnly Read more...} */ returnFirstValueOnly?: boolean; /** * Specifies the approximate number of locations to sample from the provided geometry when the input geometry is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygon} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sampleCount Read more...} */ sampleCount?: number | nullish; /** * Specifies the distance interval to sample points from the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#geometry geometry} when input geometry is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sampleDistance Read more...} */ sampleDistance?: number | nullish; /** * Specifies the slice id of a multidimensional raster. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#sliceId Read more...} */ sliceId?: number | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} for which to perform sampling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleParameters.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; } export interface ImageSampleResult extends Accessor, JSONSupport { } export class ImageSampleResult { /** * The result from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples getSamples} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} containing array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSample.html ImageSample}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html Read more...} */ constructor(properties?: ImageSampleResultProperties); /** * An array of image sample results returned in response to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples ImageryLayer.getSamples()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html#samples Read more...} */ get samples(): ImageSample[]; set samples(value: ImageSampleProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageSampleResult; } interface ImageSampleResultProperties { /** * An array of image sample results returned in response to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getSamples ImageryLayer.getSamples()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageSampleResult.html#samples Read more...} */ samples?: ImageSampleProperties[]; } export class ImageToMapMultirayParameters extends JSONSupport { /** * The rasterIds of the raster items that correspond to the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#geometries geometries}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#rasterIds Read more...} */ rasterIds: number[]; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageToMapMultiray ImageryLayer.imageToMapMultiray()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#imageToMapMultiray imageService.imageToMapMultiray()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html Read more...} */ constructor(properties?: ImageToMapMultirayParametersProperties); /** * An array of geometries in image space coordinates representing the same map location on different images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#geometries Read more...} */ get geometries(): GeometryUnion[]; set geometries(value: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]); /** * The spatial reference for the output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageToMapMultirayParameters; } interface ImageToMapMultirayParametersProperties { /** * An array of geometries in image space coordinates representing the same map location on different images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#geometries Read more...} */ geometries?: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]; /** * The spatial reference for the output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * The rasterIds of the raster items that correspond to the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#geometries geometries}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapMultirayParameters.html#rasterIds Read more...} */ rasterIds?: number[]; } export class ImageToMapParameters extends JSONSupport { /** * When `true`, it will adjust the background vertices to be in the foreground. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#adjust Read more...} */ adjust: boolean; /** * The depth offset. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#depthOffset Read more...} */ depthOffset: number; /** * The corresponding raster id for the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#rasterId Read more...} */ rasterId: number; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#imageToMap ImageryLayer.imageToMap()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#imageToMap imageService.imageToMap()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html Read more...} */ constructor(properties?: ImageToMapParametersProperties); /** * The geometry in an image space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#geometry Read more...} */ get geometry(): Multipoint | Point | Polygon | Polyline; set geometry(value: | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" })); /** * The spatial reference for the output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageToMapParameters; } interface ImageToMapParametersProperties { /** * When `true`, it will adjust the background vertices to be in the foreground. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#adjust Read more...} */ adjust?: boolean; /** * The depth offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#depthOffset Read more...} */ depthOffset?: number; /** * The geometry in an image space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#geometry Read more...} */ geometry?: | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }); /** * The spatial reference for the output geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * The corresponding raster id for the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageToMapParameters.html#rasterId Read more...} */ rasterId?: number; } export class ImageUrlParameters extends JSONSupport { /** * The raster's object id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#rasterId Read more...} */ rasterId: number; /** * The relative reference to the image's uri. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#referenceUri Read more...} */ referenceUri: string; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getImageUrl ImageryLayer.getImageUrl()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#getImageUrl imageService.getImageUrl()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html Read more...} */ constructor(properties?: ImageUrlParametersProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageUrlParameters; } interface ImageUrlParametersProperties { /** * The raster's object id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#rasterId Read more...} */ rasterId?: number; /** * The relative reference to the image's uri. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlParameters.html#referenceUri Read more...} */ referenceUri?: string; } export interface ImageUrlResult extends Accessor, JSONSupport { } export class ImageUrlResult { /** * Image's url. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlResult.html#url Read more...} */ url: string; /** * The result returned when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#getImageUrl ImageryLayer.getImageUrl()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#getImageUrl imageService.getImageUrl()} method resolves successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlResult.html Read more...} */ constructor(properties?: ImageUrlResultProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageUrlResult; } interface ImageUrlResultProperties { /** * Image's url. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageUrlResult.html#url Read more...} */ url?: string; } export interface ImageVolume extends Accessor, JSONSupport { } export class ImageVolume { /** * Area of the surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#area Read more...} */ area: number; /** * The cut volume. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#cut Read more...} */ cut: number; /** * Cut cell count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#cutCellCount Read more...} */ cutCellCount: number | nullish; /** * The fill volume (negative). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#fill Read more...} */ fill: number; /** * Fill cell count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#fillCellCount Read more...} */ fillCellCount: number | nullish; /** * Maximum z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#maxZ Read more...} */ maxZ: number; /** * Average z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#meanZ Read more...} */ meanZ: number; /** * Minimum z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#minZ Read more...} */ minZ: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume calculateVolume} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} returns * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html ImageVolumeResult} containing array of this class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html Read more...} */ constructor(properties?: ImageVolumeProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageVolume; } interface ImageVolumeProperties { /** * Area of the surface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#area Read more...} */ area?: number; /** * The cut volume. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#cut Read more...} */ cut?: number; /** * Cut cell count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#cutCellCount Read more...} */ cutCellCount?: number | nullish; /** * The fill volume (negative). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#fill Read more...} */ fill?: number; /** * Fill cell count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#fillCellCount Read more...} */ fillCellCount?: number | nullish; /** * Maximum z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#maxZ Read more...} */ maxZ?: number; /** * Average z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#meanZ Read more...} */ meanZ?: number; /** * Minimum z of the surface perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html#minZ Read more...} */ minZ?: number; } export interface ImageVolumeParameters extends Accessor, JSONSupport, Clonable { } export class ImageVolumeParameters { /** * Surface type of the base elevation plane. * * @default "plane" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#baseType Read more...} */ baseType: "constant" | "plane" | "minimum" | "maximum" | "average"; /** * Constant Z value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#constantZ Read more...} */ constantZ: number | nullish; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume calculateVolume()} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html Read more...} */ constructor(properties?: ImageVolumeParametersProperties); /** * An array of geometries containing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extents} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygons}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#geometries Read more...} */ get geometries(): GeometryUnion[]; set geometries(value: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]); /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the measure is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#mosaicRule Read more...} */ get mosaicRule(): MosaicRule | nullish; set mosaicRule(value: MosaicRuleProperties | nullish); /** * Specifies the pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#pixelSize Read more...} */ get pixelSize(): Point | nullish; set pixelSize(value: (PointProperties & { type: "point" }) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageVolumeParameters; } interface ImageVolumeParametersProperties { /** * Surface type of the base elevation plane. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#baseType Read more...} */ baseType?: "constant" | "plane" | "minimum" | "maximum" | "average"; /** * Constant Z value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#constantZ Read more...} */ constantZ?: number | nullish; /** * An array of geometries containing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extents} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html polygons}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#geometries Read more...} */ geometries?: ( | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) )[]; /** * Specifies the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-MosaicRule.html mosaic rule} on how individual images should be mosaicked * when the measure is computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#mosaicRule Read more...} */ mosaicRule?: MosaicRuleProperties | nullish; /** * Specifies the pixel size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeParameters.html#pixelSize Read more...} */ pixelSize?: (PointProperties & { type: "point" }) | nullish; } export interface ImageVolumeResult extends Accessor, JSONSupport { } export class ImageVolumeResult { /** * The result from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume calculateVolume} * method on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} containing array of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolume.html ImageVolume}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html Read more...} */ constructor(properties?: ImageVolumeResultProperties); /** * An array of image volume results returned in response to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume ImageryLayer.calculateVolume()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html#volumes Read more...} */ get volumes(): ImageVolume[]; set volumes(value: ImageVolumeProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ImageVolumeResult; } interface ImageVolumeResultProperties { /** * An array of image volume results returned in response to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#calculateVolume ImageryLayer.calculateVolume()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ImageVolumeResult.html#volumes Read more...} */ volumes?: ImageVolumeProperties[]; } export interface JobInfo extends Accessor, JSONSupport { } export class JobInfo { /** * The unique job ID assigned by geoprocessing server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#jobId Read more...} */ jobId: string; /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#jobStatus Read more...} */ jobStatus: | "job-cancelled" | "job-cancelling" | "job-deleted" | "job-deleting" | "job-timed-out" | "job-executing" | "job-failed" | "job-new" | "job-submitted" | "job-succeeded" | "job-waiting"; /** * Displays the progress of the geoprocessing job. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#progress Read more...} */ readonly progress: JobInfoProgress | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for data requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#requestOptions Read more...} */ requestOptions: any | nullish; /** * GeoScene Server Rest API endpoint to the resource that receives the geoprocessing request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#sourceUrl Read more...} */ sourceUrl: string; /** * Represents information pertaining to the execution of an asynchronous * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor.html geoprocessor} request on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html Read more...} */ constructor(properties?: JobInfoProperties); /** * An array of messages that include a type and description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#messages Read more...} */ get messages(): GPMessage[] | nullish; set messages(value: GPMessageProperties[] | nullish); /** * Cancels an asynchronous geoprocessing job. * * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#cancelJob Read more...} */ cancelJob(requestOptions?: RequestOptions): Promise; /** * Sends a request for the current state of this job. * * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#checkJobStatus Read more...} */ checkJobStatus(requestOptions?: any | null): Promise; /** * Stop monitoring this job for status updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#destroy Read more...} */ destroy(): void; /** * Sends a request to the GP Task to get the task result identified by `resultName`. * * @param resultName The name of the result parameter as defined in Services Directory. * @param gpOptions Input options for the geoprocessing service return values. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultData Read more...} */ fetchResultData(resultName: string, gpOptions?: GPOptions | null, requestOptions?: any | null): Promise; /** * Sends a request to the GP Task to get the task result identified by `jobId` and `resultName` as an image. * * @param resultName The name of the result parameter as defined in the Services Directory. * @param imageParams Specifies the properties of the result image. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request (will override requestOptions defined during construction). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultImage Read more...} */ fetchResultImage(resultName: string, imageParams: ImageParameters, requestOptions?: RequestOptions): Promise; /** * Get the task result identified by `jobId` as an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fetchResultMapImageLayer Read more...} */ fetchResultMapImageLayer(): Promise; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#toJSON Read more...} */ toJSON(): any; /** * Resolves when an asynchronous job has completed. * * @param options Options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#waitForJobCompletion Read more...} */ waitForJobCompletion(options?: JobInfoWaitForJobCompletionOptions): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): JobInfo; } interface JobInfoProperties { /** * The unique job ID assigned by geoprocessing server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#jobId Read more...} */ jobId?: string; /** * The job status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#jobStatus Read more...} */ 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 a type and description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#messages Read more...} */ messages?: GPMessageProperties[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for data requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#requestOptions Read more...} */ requestOptions?: any | nullish; /** * GeoScene Server Rest API endpoint to the resource that receives the geoprocessing request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-JobInfo.html#sourceUrl Read more...} */ sourceUrl?: string; } export interface JobInfoProgress { message: string; percent?: number | undefined; } export interface JobInfoWaitForJobCompletionOptions { interval?: any; signal?: any; statusCallback?: any; } export class LegendLayer extends Accessor { /** * The id of the operational layer to include in the printout's legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#layerId Read more...} */ layerId: string; /** * The ids of the sublayers to include in the printout's legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#subLayerIds Read more...} */ subLayerIds: string[]; /** * The title of the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#title Read more...} */ title: string; /** * Define layer properties for the legend layers associated with a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html PrintTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html Read more...} */ constructor(properties?: LegendLayerProperties); } interface LegendLayerProperties { /** * The id of the operational layer to include in the printout's legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#layerId Read more...} */ layerId?: string; /** * The ids of the sublayers to include in the printout's legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#subLayerIds Read more...} */ subLayerIds?: string[]; /** * The title of the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LegendLayer.html#title Read more...} */ title?: string; } export interface LengthsParameters extends Accessor, JSONSupport { } export class LengthsParameters { /** * Defines the type of calculation for the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#calculationType Read more...} */ calculationType: "planar" | "geodesic" | "preserve-shape" | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#geodesic Read more...} */ geodesic: boolean | nullish; /** * The length unit in which perimeters of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#lengthUnit Read more...} */ lengthUnit: number | string; /** * Sets the length units and other parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#lengths geometryService.lengths()} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html Read more...} */ constructor(properties?: LengthsParametersProperties); /** * The array of polylines whose lengths are to be computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#polylines Read more...} */ get polylines(): Polyline[] | nullish; set polylines(value: PolylineProperties[] | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LengthsParameters; } interface LengthsParametersProperties { /** * Defines the type of calculation for the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#calculationType Read more...} */ calculationType?: "planar" | "geodesic" | "preserve-shape" | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#geodesic Read more...} */ geodesic?: boolean | nullish; /** * The length unit in which perimeters of polygons will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#lengthUnit Read more...} */ lengthUnit?: number | string; /** * The array of polylines whose lengths are to be computed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LengthsParameters.html#polylines Read more...} */ polylines?: PolylineProperties[] | nullish; } export interface LinearUnit extends Accessor, JSONSupport { } export class LinearUnit { /** * Specifies the value of the linear distance. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#distance Read more...} */ distance: number; /** * Specifies the unit type of the linear distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#units Read more...} */ units: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "international-feet" | "international-inches" | "international-miles" | "international-nautical-miles" | "international-yards" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards" | "unknown" | "us-feet" | nullish; /** * A geoprocessing object that describes a distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html Read more...} */ constructor(properties?: LinearUnitProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LinearUnit; } interface LinearUnitProperties { /** * Specifies the value of the linear distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#distance Read more...} */ distance?: number; /** * Specifies the unit type of the linear distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-LinearUnit.html#units Read more...} */ units?: | "centimeters" | "decimal-degrees" | "decimeters" | "feet" | "inches" | "international-feet" | "international-inches" | "international-miles" | "international-nautical-miles" | "international-yards" | "kilometers" | "meters" | "miles" | "millimeters" | "nautical-miles" | "points" | "yards" | "unknown" | "us-feet" | nullish; } export class MapToImageParameters extends JSONSupport { /** * The raster id of the raster item corresponding to the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#rasterId Read more...} */ rasterId: number; /** * When `true`, the operation will return an empty geometry if the input geometry is not visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#visibleOnly Read more...} */ visibleOnly: boolean; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#mapToImage ImageryLayer.mapToImage()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#mapToImage imageService.mapToImage()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html Read more...} */ constructor(properties?: MapToImageParametersProperties); /** * The geometry in a map space (coordinates). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#geometry Read more...} */ get geometry(): Extent | Multipoint | Point | Polygon | Polyline | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MapToImageParameters; } interface MapToImageParametersProperties { /** * The geometry in a map space (coordinates). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | nullish; /** * The raster id of the raster item corresponding to the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#rasterId Read more...} */ rasterId?: number; /** * When `true`, the operation will return an empty geometry if the input geometry is not visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MapToImageParameters.html#visibleOnly Read more...} */ visibleOnly?: boolean; } export interface MeasureAreaFromImageResult extends Accessor, JSONSupport { } export class MeasureAreaFromImageResult { /** * The area of a polygon in square meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#area Read more...} */ area: number; /** * The perimeter of a polygon in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#length Read more...} */ length: number; /** * The area and length result from a selected image's measurement in an image space when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaFromImage ImageryLayer.measureAreaFromImage()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaFromImage imageService.measureAreaFromImage()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html Read more...} */ constructor(properties?: MeasureAreaFromImageResultProperties); /** * The polygon's center in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#center Read more...} */ get center(): Point; set center(value: PointProperties); /** * The polygon geometry in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#geometry Read more...} */ get geometry(): Polygon; set geometry(value: PolygonProperties & { type: "polygon" }); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeasureAreaFromImageResult; } interface MeasureAreaFromImageResultProperties { /** * The area of a polygon in square meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#area Read more...} */ area?: number; /** * The polygon's center in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#center Read more...} */ center?: PointProperties; /** * The polygon geometry in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#geometry Read more...} */ geometry?: PolygonProperties & { type: "polygon" }; /** * The perimeter of a polygon in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureAreaFromImageResult.html#length Read more...} */ length?: number; } export interface MeasureFromImageParameters extends Accessor, JSONSupport { } export class MeasureFromImageParameters { /** * The id of the raster to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#rasterId Read more...} */ rasterId: number; /** * Input parameters used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureLengthFromImage ImageryLayer.measureLengthFromImage()}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureAreaFromImage ImageryLayer.measureAreaFromImage()}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureLengthFromImage imageService.measureLengthFromImage()} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureAreaFromImage imageService.measureAreaFromImage()} methods to perform imagery * area, perimeter and length mensuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html Read more...} */ constructor(properties?: MeasureFromImageParametersProperties); /** * The polyline or polygon geometry used to perform length or area measurements in an image space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#geometry Read more...} */ get geometry(): Polyline | Polygon; set geometry(value: (PolylineProperties & { type: "polyline" }) | (PolygonProperties & { type: "polygon" })); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeasureFromImageParameters; } interface MeasureFromImageParametersProperties { /** * The polyline or polygon geometry used to perform length or area measurements in an image space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#geometry Read more...} */ geometry?: (PolylineProperties & { type: "polyline" }) | (PolygonProperties & { type: "polygon" }); /** * The id of the raster to be measured. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureFromImageParameters.html#rasterId Read more...} */ rasterId?: number; } export interface MeasureLengthFromImageResult extends Accessor, JSONSupport { } export class MeasureLengthFromImageResult { /** * The length of a polyline in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#length Read more...} */ length: number; /** * The length result from a selected image's measurement in an image space when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html#measureLengthFromImage ImageryLayer.measureLengthFromImage()} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-imageService.html#measureLengthFromImage imageService.measureLengthFromImage()} methods resolve successfully. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html Read more...} */ constructor(properties?: MeasureLengthFromImageResultProperties); /** * Polyline geometry in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#geometry Read more...} */ get geometry(): Polyline; set geometry(value: PolylineProperties & { type: "polyline" }); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): MeasureLengthFromImageResult; } interface MeasureLengthFromImageResultProperties { /** * Polyline geometry in a map space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#geometry Read more...} */ geometry?: PolylineProperties & { type: "polyline" }; /** * The length of a polyline in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MeasureLengthFromImageResult.html#length Read more...} */ length?: number; } export class MultipartColorRamp extends ColorRamp { /** * A string value representing the color ramp type. * * @default "multipart" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MultipartColorRamp.html#type Read more...} */ readonly type: "multipart"; /** * Creates a multipart color ramp to combine multiple continuous color ramps for use in raster * renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MultipartColorRamp.html Read more...} */ constructor(properties?: MultipartColorRampProperties); /** * Define an array of algorithmic color ramps used to generate the multi part ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MultipartColorRamp.html#colorRamps Read more...} */ get colorRamps(): AlgorithmicColorRamp[] | nullish; set colorRamps(value: AlgorithmicColorRampProperties[] | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MultipartColorRamp.html#clone Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-MultipartColorRamp.html#colorRamps Read more...} */ colorRamps?: AlgorithmicColorRampProperties[] | nullish; } export interface NAMessage extends Accessor, JSONSupport { } export class NAMessage { /** * A description of the network analyst message. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#description Read more...} */ description: string | nullish; /** * The network analyst message type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#type Read more...} */ type: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort" | nullish; /** * Represents a message generated during the execution of a network analyst task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html Read more...} */ constructor(properties?: NAMessageProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): NAMessage; } interface NAMessageProperties { /** * A description of the network analyst message. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#description Read more...} */ description?: string | nullish; /** * The network analyst message type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html#type Read more...} */ type?: | "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort" | nullish; } export interface NetworkFeatureSet extends FeatureSet, Accessor { } export class NetworkFeatureSet { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkFeatureSet.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements: boolean | nullish; /** * A subclass of FeaureSet that can be used as an input in the Route, Closest Facility, and Service Area solvers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkFeatureSet.html Read more...} */ constructor(properties?: NetworkFeatureSetProperties); static fromJSON(json: any): NetworkFeatureSet; } interface NetworkFeatureSetProperties extends FeatureSetProperties { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkFeatureSet.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements?: boolean | nullish; } export interface NetworkUrl extends Accessor, JSONSupport { } export class NetworkUrl { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements: boolean | nullish; /** * A url to any GeoScene Server feature, map, or geoprocessing service that returns a JSON feature set. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#url Read more...} */ url: string | nullish; /** * An input type for Route, Closest Facility, and Service Area solvers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html Read more...} */ constructor(properties?: NetworkUrlProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): NetworkUrl; } interface NetworkUrlProperties { /** * If true, restricted network elements should be considered when finding network locations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#doNotLocateOnRestrictedElements Read more...} */ doNotLocateOnRestrictedElements?: boolean | nullish; /** * A url to any GeoScene Server feature, map, or geoprocessing service that returns a JSON feature set. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NetworkUrl.html#url Read more...} */ url?: string | nullish; } export class NormalizationBinParametersMixin { normalizationField: string | nullish; normalizationMaxValue: number | nullish; normalizationMinValue: number | nullish; normalizationTotal: number | nullish; normalizationType: "natural-log" | "square-root" | "percent-of-total" | "log" | "field" | nullish; } interface NormalizationBinParametersMixinProperties { normalizationField?: string | nullish; normalizationMaxValue?: number | nullish; normalizationMinValue?: number | nullish; normalizationTotal?: number | nullish; normalizationType?: "natural-log" | "square-root" | "percent-of-total" | "log" | "field" | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#bevelRatio Read more...} */ bevelRatio: number | nullish; /** * The array of geometries to be offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#geometries Read more...} */ geometries: GeometryUnion[] | nullish; /** * Specifies the planar distance for constructing an offset based on the input geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetDistance Read more...} */ offsetDistance: number | nullish; /** * Options that determine how the ends intersect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetHow Read more...} */ offsetHow: "bevelled" | "mitered" | "rounded" | nullish; /** * The offset distance unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetUnit Read more...} */ offsetUnit: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; /** * Sets the offset distance, type and other parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#offset geometryService.offset} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html Read more...} */ constructor(properties?: OffsetParametersProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#bevelRatio Read more...} */ bevelRatio?: number | nullish; /** * The array of geometries to be offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#geometries Read more...} */ geometries?: GeometryUnion[] | nullish; /** * Specifies the planar distance for constructing an offset based on the input geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetDistance Read more...} */ offsetDistance?: number | nullish; /** * Options that determine how the ends intersect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetHow Read more...} */ offsetHow?: "bevelled" | "mitered" | "rounded" | nullish; /** * The offset distance unit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-OffsetParameters.html#offsetUnit Read more...} */ offsetUnit?: "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards" | nullish; } export interface ParameterValue extends Accessor, JSONSupport { } export class ParameterValue { /** * Specifies the parameter's data type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#dataType Read more...} */ dataType: | "areal-unit" | "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-areal-unit" | "multi-value-boolean" | "multi-value-composite" | "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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#paramName Read more...} */ paramName: string | nullish; /** * The value of the parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#value Read more...} */ value: | ArealUnit | boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string | FeatureLayer | MapImage | ( | ArealUnit | boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string | FeatureLayer | MapImage )[]; /** * Represents the output parameters of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geoprocessor.html geoprocessor} method * and their properties and values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html Read more...} */ constructor(properties?: ParameterValueProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ParameterValue; } interface ParameterValueProperties { /** * Specifies the parameter's data type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#dataType Read more...} */ dataType?: | "areal-unit" | "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-areal-unit" | "multi-value-boolean" | "multi-value-composite" | "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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#paramName Read more...} */ paramName?: string | nullish; /** * The value of the parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ParameterValue.html#value Read more...} */ value?: | ArealUnit | boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string | FeatureLayer | MapImage | ( | ArealUnit | boolean | DataFile | Date | number | FeatureSet | Field | LinearUnit | RasterData | string | FeatureLayer | MapImage )[]; } export class PlaceResult extends Accessor { /** * An array of category objects for a place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#categories Read more...} */ categories: Category[]; /** * The distance, in meters, from the place to the search point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#distance Read more...} */ distance: number | nullish; /** * Url for an icon for this place in either cim, png or svg format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#icon Read more...} */ icon: any | nullish; /** * The name of the place, or point of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#name Read more...} */ name: string; /** * The unique Id of this place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#placeId Read more...} */ placeId: string; /** * The `PlaceResult` object includes a single place that satisfies the search and * either: the distance from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#point search point} * in meters, or falls within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#extent extent} of the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html Read more...} */ constructor(properties?: PlaceResultProperties); /** * A location defined by X and Y coordinates in WGS84. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#location Read more...} */ get location(): Point; set location(value: PointProperties); } interface PlaceResultProperties { /** * An array of category objects for a place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#categories Read more...} */ categories?: Category[]; /** * The distance, in meters, from the place to the search point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#distance Read more...} */ distance?: number | nullish; /** * Url for an icon for this place in either cim, png or svg format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#icon Read more...} */ icon?: any | nullish; /** * A location defined by X and Y coordinates in WGS84. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#location Read more...} */ location?: PointProperties; /** * The name of the place, or point of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#name Read more...} */ name?: string; /** * The unique Id of this place. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#placeId Read more...} */ placeId?: string; } /** * Each category object has a categoryId and a label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlaceResult.html#Category Read more...} */ export interface Category { categoryId: number; label: string; } export class PlacesParameters extends Accessor { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#apiKey Read more...} */ apiKey: string | nullish; /** * Determines whether icons are returned and the type of icons returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#icon Read more...} */ icon: "cim" | "png" | "svg" | nullish; /** * URL to the places service. * * @default "https://places-api.geoscene.cn/geoscene/rest/services/places-service/v1" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#url Read more...} */ url: string; /** * The following properties define common properties * for use with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html places}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html Read more...} */ constructor(properties?: PlacesParametersProperties); } interface PlacesParametersProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#apiKey Read more...} */ apiKey?: string | nullish; /** * Determines whether icons are returned and the type of icons returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#icon Read more...} */ icon?: "cim" | "png" | "svg" | nullish; /** * URL to the places service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesParameters.html#url Read more...} */ url?: string; } export class PlacesQueryParameters extends PlacesParameters { /** * Filters places to those that match the category Ids. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#categoryIds Read more...} */ categoryIds: string[] | nullish; /** * Request results starting from the given offset. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#offset Read more...} */ offset: number; /** * The number of places that should be sent in the response for a single request. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#pageSize Read more...} */ pageSize: number; /** * The radius in meters to search for places, measured from the supplied {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#point point}. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#radius Read more...} */ radius: number; /** * Free search text for places against names, categories, etc. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#searchText Read more...} */ searchText: string | nullish; /** * The following properties define the parameters for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesNearPoint queryPlacesNearPoint()} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesWithinExtent queryPlacesWithinExtent()} methods pointing to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#url url} that represents a places service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html Read more...} */ constructor(properties?: PlacesQueryParametersProperties); /** * The extent of the bounding box to be searched inside. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#extent Read more...} */ get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); /** * A location defined by X and Y coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#point Read more...} */ get point(): Point | nullish; set point(value: PointProperties | nullish); /** * Creates a deep clone of the instance of PlacesQueryParameters that this method is called on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#clone Read more...} */ clone(): PlacesQueryParameters; } interface PlacesQueryParametersProperties extends PlacesParametersProperties { /** * Filters places to those that match the category Ids. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#categoryIds Read more...} */ categoryIds?: string[] | nullish; /** * The extent of the bounding box to be searched inside. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#extent Read more...} */ extent?: ExtentProperties | nullish; /** * Request results starting from the given offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#offset Read more...} */ offset?: number; /** * The number of places that should be sent in the response for a single request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#pageSize Read more...} */ pageSize?: number; /** * A location defined by X and Y coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#point Read more...} */ point?: PointProperties | nullish; /** * The radius in meters to search for places, measured from the supplied {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#point point}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#radius Read more...} */ radius?: number; /** * Free search text for places against names, categories, etc. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryParameters.html#searchText Read more...} */ searchText?: string | nullish; } export class PlacesQueryResult extends Accessor { /** * The query parameters for the next set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#nextQueryParams Read more...} */ nextQueryParams: PlacesQueryParameters | nullish; /** * The query parameters for the previous set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#previousQueryParams Read more...} */ previousQueryParams: PlacesQueryParameters | nullish; /** * The `PlacesQueryResult` object includes the results from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesNearPoint queryPlacesNearPoint()} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesWithinExtent queryPlacesWithinExtent()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html Read more...} */ constructor(properties?: PlacesQueryResultProperties); /** * An array of results from searching for places using the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesNearPoint queryPlacesNearPoint()} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesWithinExtent queryPlacesWithinExtent()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#results Read more...} */ get results(): PlaceResult[]; set results(value: PlaceResultProperties[]); } interface PlacesQueryResultProperties { /** * The query parameters for the next set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#nextQueryParams Read more...} */ nextQueryParams?: PlacesQueryParameters | nullish; /** * The query parameters for the previous set of results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#previousQueryParams Read more...} */ previousQueryParams?: PlacesQueryParameters | nullish; /** * An array of results from searching for places using the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesNearPoint queryPlacesNearPoint()} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html#queryPlacesWithinExtent queryPlacesWithinExtent()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PlacesQueryResult.html#results Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#barrierType Read more...} */ barrierType: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * The direction of traffic that is affected by the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#curbApproach Read more...} */ readonly curbApproach: | "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn" | nullish; /** * Point barriers are applied to the edge elements during the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#fullEdge Read more...} */ fullEdge: "permit" | "restrict" | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#name Read more...} */ name: string | nullish; readonly type: "point-barrier"; /** * A point barrier to restrict travel along a street network when using a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html Read more...} */ constructor(properties?: PointBarrierProperties); /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#geometry Read more...} */ get geometry(): Point | nullish; set geometry(value: PointProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html PointBarrier} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html PointBarrier} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): PointBarrier; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PointBarrier; } interface PointBarrierProperties { /** * Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#barrierType Read more...} */ barrierType?: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * Point barriers are applied to the edge elements during the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#fullEdge Read more...} */ fullEdge?: "permit" | "restrict" | nullish; /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#geometry Read more...} */ geometry?: PointProperties | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#name Read more...} */ name?: string | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PointBarrier.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#barrierType Read more...} */ barrierType: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#name Read more...} */ name: string | nullish; readonly type: "polygon-barrier"; /** * A polygon barrier to restrict travel along a street network when using a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html Read more...} */ constructor(properties?: PolygonBarrierProperties); /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#geometry Read more...} */ get geometry(): Polygon | nullish; set geometry(value: PolygonProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html PolygonBarrier} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html PolygonBarrier} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): PolygonBarrier; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#barrierType Read more...} */ barrierType?: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#geometry Read more...} */ geometry?: PolygonProperties | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#name Read more...} */ name?: string | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolygonBarrier.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#barrierType Read more...} */ barrierType: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#name Read more...} */ name: string | nullish; readonly type: "polyline-barrier"; /** * A polyline barrier to restrict travel along a street network when using a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html Read more...} */ constructor(properties?: PolylineBarrierProperties); /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#geometry Read more...} */ get geometry(): Polyline | nullish; set geometry(value: PolylineProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html PolylineBarrier} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html PolylineBarrier} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): PolylineBarrier; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PolylineBarrier; } interface PolylineBarrierProperties { /** * Specify whether the barrier restricts travel completely or scales time or distance when it is crossed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#barrierType Read more...} */ barrierType?: "added-cost" | "restriction" | "scaled-cost" | nullish; /** * The point location of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#geometry Read more...} */ geometry?: PolylineProperties | nullish; /** * The name of the barrier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#name Read more...} */ name?: string | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PolylineBarrier.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; } export class PrintParameters extends Accessor { /** * Additional parameters for the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#extraParameters Read more...} */ extraParameters: any; /** * Defines the layout template used for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#template Read more...} */ template: PrintTemplate; /** * The view to print. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#view Read more...} */ view: MapView; /** * Input parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html print}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html Read more...} */ constructor(properties?: PrintParametersProperties); /** * Specify the output spatial reference for the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); } interface PrintParametersProperties { /** * Additional parameters for the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#extraParameters Read more...} */ extraParameters?: any; /** * Specify the output spatial reference for the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * Defines the layout template used for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#template Read more...} */ template?: PrintTemplate; /** * The view to print. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintParameters.html#view Read more...} */ view?: MapView; } export class PrintTemplate extends Accessor { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#attributionVisible Read more...} */ attributionVisible: boolean; /** * Define the map width, height and dpi. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#exportOptions Read more...} */ exportOptions: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for * rendering. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#forceFeatureAttributes Read more...} */ forceFeatureAttributes: boolean; /** * The output format for the printed map. * * @default "png32" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#format Read more...} */ format: "gif" | "jpg" | "png8" | "png32" | "tiff" | "pdf" | "svg" | "svgz" | "aix" | "eps"; /** * When `true`, charts will be included in the printout request. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#includeCharts Read more...} */ includeCharts: boolean; /** * When `true`, tables will be included in the printout request. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#includeTables Read more...} */ includeTables: boolean; /** * The layout used for the print output. * * @default "map-only" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layout Read more...} */ 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" | nullish; /** * Defines the layout elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layoutOptions Read more...} */ layoutOptions: PrintTemplateLayoutOptions | nullish; /** * The optional map scale of the printed map. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#outScale Read more...} */ outScale: number; /** * The name of the report template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#report Read more...} */ 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" | nullish; /** * This object links the various report elements to their data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#reportOptions Read more...} */ reportOptions: any | nullish; /** * Define whether the printed map should preserve map scale or map extent. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#scalePreserved Read more...} */ scalePreserved: boolean; /** * When `true`, labels will be shown on the layout. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#showLabels Read more...} */ showLabels: boolean; /** * Defines the layout template options used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-print.html print} * and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#print PrintViewModel.print()} * method to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html Read more...} */ constructor(properties?: PrintTemplateProperties); /** * A custom layout hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layoutItem Read more...} */ get layoutItem(): PortalItem | nullish; set layoutItem(value: PortalItemProperties | nullish); /** * A custom report template hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} for report printing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#reportItem Read more...} */ get reportItem(): PortalItem | nullish; set reportItem(value: PortalItemProperties | nullish); } interface PrintTemplateProperties { /** * When `false`, the attribution is not displayed on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#attributionVisible Read more...} */ attributionVisible?: boolean; /** * Define the map width, height and dpi. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#exportOptions Read more...} */ exportOptions?: PrintTemplateExportOptions; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for * rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#forceFeatureAttributes Read more...} */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#format Read more...} */ format?: "gif" | "jpg" | "png8" | "png32" | "tiff" | "pdf" | "svg" | "svgz" | "aix" | "eps"; /** * When `true`, charts will be included in the printout request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#includeCharts Read more...} */ includeCharts?: boolean; /** * When `true`, tables will be included in the printout request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#includeTables Read more...} */ includeTables?: boolean; /** * The layout used for the print output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layout Read more...} */ 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" | nullish; /** * A custom layout hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layoutItem Read more...} */ layoutItem?: PortalItemProperties | nullish; /** * Defines the layout elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#layoutOptions Read more...} */ layoutOptions?: PrintTemplateLayoutOptions | nullish; /** * The optional map scale of the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#outScale Read more...} */ outScale?: number; /** * The name of the report template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#report Read more...} */ 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" | nullish; /** * A custom report template hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} for report printing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#reportItem Read more...} */ reportItem?: PortalItemProperties | nullish; /** * This object links the various report elements to their data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#reportOptions Read more...} */ reportOptions?: any | nullish; /** * Define whether the printed map should preserve map scale or map extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#scalePreserved Read more...} */ scalePreserved?: boolean; /** * When `true`, labels will be shown on the layout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html#showLabels Read more...} */ showLabels?: boolean; } export interface PrintTemplateExportOptions { width?: number; height?: number; dpi?: number; } export interface PrintTemplateLayoutOptions { titleText?: string | nullish; authorText?: string | nullish; copyrightText?: string | nullish; scalebarUnit?: "Miles" | "Kilometers" | "Meters" | "Feet" | nullish; legendLayers?: LegendLayer[] | nullish; customTextElements?: any[] | nullish; elementOverrides?: any | nullish; } export class ProjectParameters extends Accessor { /** * The input geometries to project. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#geometries Read more...} */ geometries: GeometryUnion[]; /** * The well-known id {wkid:number} or well-known text {wkt:string} of the datum * transformation to be applied to the projected geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#transformation Read more...} */ transformation: ProjectParametersTransformation | nullish; /** * Indicates whether to transform forward or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#transformForward Read more...} */ transformForward: boolean | nullish; /** * Defines the projection parameters used when calling * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#project geometryService.project()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html Read more...} */ constructor(properties?: ProjectParametersProperties); /** * The spatial reference to which you are projecting the geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference; set outSpatialReference(value: SpatialReferenceProperties); /** * Converts an instance of this class to its GeoScene portal JSON representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#toJSON Read more...} */ toJSON(): any; } interface ProjectParametersProperties { /** * The input geometries to project. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#geometries Read more...} */ geometries?: GeometryUnion[]; /** * The spatial reference to which you are projecting the geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#outSpatialReference Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#transformation Read more...} */ transformation?: ProjectParametersTransformation | nullish; /** * Indicates whether to transform forward or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ProjectParameters.html#transformForward Read more...} */ transformForward?: boolean | nullish; } export interface ProjectParametersTransformation { wkid?: number; wkt?: string; } export interface Query extends Accessor, JSONSupport, QueryMixin { } export class Query { /** * An array of Object IDs representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#isAggregate aggregate} (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#aggregateIds Read more...} */ aggregateIds: (number | string)[] | nullish; /** * Indicates if the service should cache the query results. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#cacheHint Read more...} */ declare cacheHint: QueryMixin["cacheHint"]; /** * Datum transformation used for projecting geometries in the query results when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference outSpatialReference} is different than the layer's spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#datumTransformation Read more...} */ datumTransformation: number | SimpleTransformation | CompositeTransformation | nullish; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#distance Read more...} */ declare distance: QueryMixin["distance"]; /** * Specifies the geodatabase version to display for feature service queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Specifies the number of decimal places for geometries returned by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeQueryJSON JSON query operation}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * Used only in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#statistic statistical queries}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#groupByFieldsForStatistics Read more...} */ groupByFieldsForStatistics: string[] | nullish; /** * A condition used with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outStatistics outStatistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#groupByFieldsForStatistics groupByFieldsForStatistics} * to limit query results to groups that * satisfy the aggregation function(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#having Read more...} */ having: string | nullish; /** * The maximum distance in units of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference outSpatialReference} used for * generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#maxAllowableOffset Read more...} */ maxAllowableOffset: number | nullish; /** * When set, the maximum number of features returned by the query will equal the * `maxRecordCount` of the service multiplied by this factor. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#maxRecordCountFactor Read more...} */ maxRecordCountFactor: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#multipatchOption Read more...} */ multipatchOption: string | nullish; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#num Read more...} */ num: number | nullish; /** * An array of ObjectIDs to be used to query for features in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#objectIds Read more...} */ objectIds: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * Attribute fields to include in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outFields Read more...} */ outFields: string[] | nullish; /** * Filters features from the layer based on pre-authored parameterized filters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#parameterValues Read more...} */ parameterValues: HashMap | nullish; /** * Filters features from the layer that are within the specified range values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#rangeValues Read more...} */ rangeValues: QueryRangeValues[] | nullish; /** * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query * the spatial relationship of the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} to the layer's features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#relationParameter Read more...} */ relationParameter: string | nullish; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} will be returned with a centroid. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnCentroid Read more...} */ returnCentroid: boolean; /** * If `true` then the query returns distinct values based on the field(s) specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outFields outFields}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnDistinctValues Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnExceededLimitFeatures Read more...} */ returnExceededLimitFeatures: boolean; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnM Read more...} */ returnM: boolean | nullish; /** * If `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#queryGeometry query geometry} will be returned with the query results. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnQueryGeometry Read more...} */ returnQueryGeometry: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnZ Read more...} */ returnZ: boolean | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry}. * * @default intersects * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#spatialRelationship Read more...} */ declare spatialRelationship: QueryMixin["spatialRelationship"]; /** * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#sqlFormat Read more...} */ sqlFormat: "none" | "standard" | "native" | nullish; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#start Read more...} */ start: number | nullish; /** * Shorthand for a where clause using "like". * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#text Read more...} */ text: string | nullish; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#distance distance} is specified in spatial queries. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#units Read more...} */ declare units: QueryMixin["units"]; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#where Read more...} */ declare where: QueryMixin["where"]; /** * This class defines parameters for executing queries for features from a layer or layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Read more...} */ constructor(properties?: QueryProperties); /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * The definitions for one or more field-based statistics to be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outStatistics Read more...} */ get outStatistics(): StatisticDefinition[] | nullish; set outStatistics(value: StatisticDefinitionProperties[] | nullish); /** * Specifies the pixel level to be identified on the X and Y axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#pixelSize Read more...} */ get pixelSize(): Point | nullish; set pixelSize(value: PointProperties | nullish); /** * Used to project the geometry onto a virtual grid, likely representing * pixels on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#quantizationParameters Read more...} */ get quantizationParameters(): QueryQuantizationParameters | nullish; set quantizationParameters(value: QueryQuantizationParametersProperties | nullish); /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Creates a deep clone of Query object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#clone Read more...} */ clone(): Query; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Query; } interface QueryProperties extends QueryMixinProperties { /** * An array of Object IDs representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html#isAggregate aggregate} (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#aggregateIds Read more...} */ aggregateIds?: (number | string)[] | nullish; /** * Indicates if the service should cache the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#cacheHint Read more...} */ cacheHint?: QueryMixinProperties["cacheHint"]; /** * Datum transformation used for projecting geometries in the query results when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference outSpatialReference} is different than the layer's spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#datumTransformation Read more...} */ datumTransformation?: number | SimpleTransformation | CompositeTransformation | nullish; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#distance Read more...} */ distance?: QueryMixinProperties["distance"]; /** * Specifies the geodatabase version to display for feature service queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * Specifies the number of decimal places for geometries returned by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query.html#executeQueryJSON JSON query operation}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * Used only in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#statistic statistical queries}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#groupByFieldsForStatistics Read more...} */ groupByFieldsForStatistics?: string[] | nullish; /** * A condition used with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outStatistics outStatistics} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#groupByFieldsForStatistics groupByFieldsForStatistics} * to limit query results to groups that * satisfy the aggregation function(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#having Read more...} */ having?: string | nullish; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The maximum distance in units of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference outSpatialReference} used for * generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#maxAllowableOffset Read more...} */ maxAllowableOffset?: number | nullish; /** * When set, the maximum number of features returned by the query will equal the * `maxRecordCount` of the service multiplied by this factor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#maxRecordCountFactor Read more...} */ maxRecordCountFactor?: number; /** * Parameter dictates how the geometry of a multipatch feature will be returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#multipatchOption Read more...} */ multipatchOption?: string | nullish; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#num Read more...} */ num?: number | nullish; /** * An array of ObjectIDs to be used to query for features in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#objectIds Read more...} */ objectIds?: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * Attribute fields to include in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outFields Read more...} */ outFields?: string[] | nullish; /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * The definitions for one or more field-based statistics to be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outStatistics Read more...} */ outStatistics?: StatisticDefinitionProperties[] | nullish; /** * Filters features from the layer based on pre-authored parameterized filters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#parameterValues Read more...} */ parameterValues?: HashMap | nullish; /** * Specifies the pixel level to be identified on the X and Y axis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#pixelSize Read more...} */ pixelSize?: PointProperties | nullish; /** * Used to project the geometry onto a virtual grid, likely representing * pixels on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#quantizationParameters Read more...} */ quantizationParameters?: QueryQuantizationParametersProperties | nullish; /** * Filters features from the layer that are within the specified range values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#rangeValues Read more...} */ rangeValues?: QueryRangeValues[] | nullish; /** * The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query * the spatial relationship of the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry} to the layer's features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#relationParameter Read more...} */ relationParameter?: string | nullish; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} will be returned with a centroid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnCentroid Read more...} */ returnCentroid?: boolean; /** * If `true` then the query returns distinct values based on the field(s) specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#outFields outFields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnDistinctValues Read more...} */ 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`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnExceededLimitFeatures Read more...} */ returnExceededLimitFeatures?: boolean; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnM Read more...} */ returnM?: boolean | nullish; /** * If `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html#queryGeometry query geometry} will be returned with the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnQueryGeometry Read more...} */ returnQueryGeometry?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#returnZ Read more...} */ returnZ?: boolean | nullish; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#spatialRelationship Read more...} */ spatialRelationship?: QueryMixinProperties["spatialRelationship"]; /** * This parameter can be either standard SQL92 `standard` or it can use the native SQL of the underlying datastore `native`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#sqlFormat Read more...} */ sqlFormat?: "none" | "standard" | "native" | nullish; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#start Read more...} */ start?: number | nullish; /** * Shorthand for a where clause using "like". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#text Read more...} */ text?: string | nullish; /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#distance distance} is specified in spatial queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#units Read more...} */ units?: QueryMixinProperties["units"]; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html#where Read more...} */ where?: QueryMixinProperties["where"]; } export interface CompositeTransformation { geoTransforms: CompositeTransformationGeoTransforms[]; } export interface QueryQuantizationParametersProperties { extent?: ExtentProperties | nullish; mode?: "view" | "edit"; originPosition?: "upper-left" | "lower-left"; tolerance?: number; } export interface QueryQuantizationParameters extends AnonymousAccessor { get extent(): Extent | nullish; set extent(value: ExtentProperties | nullish); mode: "view" | "edit"; originPosition: "upper-left" | "lower-left"; tolerance: number; } export interface QueryRangeValues { name: string; value: number | number[]; } export interface SimpleTransformation { wkid: number; } export interface CompositeTransformationGeoTransforms { wkid: number; transformForward: boolean; } export class QueryMixin { cacheHint: boolean | nullish; distance: number | nullish; spatialRelationship: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | nullish; where: string | nullish; get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); } interface QueryMixinProperties { cacheHint?: boolean | nullish; distance?: number | nullish; geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; outSpatialReference?: SpatialReferenceProperties | nullish; spatialRelationship?: | "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"; timeExtent?: TimeExtentProperties | nullish; units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | nullish; where?: string | nullish; } export interface RasterData extends Accessor, JSONSupport { } export class RasterData { /** * The image type (e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#format Read more...} */ readonly format: string | nullish; /** * The ID of the portal item containing the raster data file or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#itemId Read more...} */ itemId: string | nullish; /** * When the output data type is an image service, this property will return `image-service`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#type Read more...} */ readonly type: "image-service" | nullish; /** * The URL to the raster data file or image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#url Read more...} */ url: string | nullish; /** * A geoprocessing data type representing raster data file or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html Read more...} */ constructor(properties?: RasterDataProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RasterData; } interface RasterDataProperties { /** * The ID of the portal item containing the raster data file or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#itemId Read more...} */ itemId?: string | nullish; /** * The URL to the raster data file or image service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RasterData.html#url Read more...} */ url?: string | nullish; } export interface RelationParameters extends Accessor, JSONSupport { } export class RelationParameters { /** * The first array of geometries to compute the relation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#geometries1 Read more...} */ geometries1: GeometryUnion[] | nullish; /** * The second array of geometries to compute the relation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#geometries2 Read more...} */ geometries2: GeometryUnion[] | nullish; /** * The spatial relationship to be tested between the two input geometry arrays. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#relation Read more...} */ relation: | "cross" | "disjoint" | "in" | "interior-intersection" | "intersection" | "line-coincidence" | "line-touch" | "overlap" | "point-touch" | "relation" | "touch" | "within" | nullish; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#relationParameter Read more...} */ relationParameter: string | nullish; /** * Sets the relation and other parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#relation geometryService.relation()} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html Read more...} */ constructor(properties?: RelationParametersProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RelationParameters; } interface RelationParametersProperties { /** * The first array of geometries to compute the relation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#geometries1 Read more...} */ geometries1?: GeometryUnion[] | nullish; /** * The second array of geometries to compute the relation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#geometries2 Read more...} */ geometries2?: GeometryUnion[] | nullish; /** * The spatial relationship to be tested between the two input geometry arrays. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#relation Read more...} */ relation?: | "cross" | "disjoint" | "in" | "interior-intersection" | "intersection" | "line-coincidence" | "line-touch" | "overlap" | "point-touch" | "relation" | "touch" | "within" | nullish; /** * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationParameters.html#relationParameter Read more...} */ relationParameter?: string | nullish; } export interface RelationshipQuery extends Accessor, JSONSupport { } export class RelationshipQuery { /** * Indicates if the service should cache the relationship query results. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#cacheHint Read more...} */ cacheHint: boolean | nullish; /** * Specify the geodatabase version to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#gdbVersion Read more...} */ gdbVersion: string | nullish; /** * Specify the number of decimal places for the geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#geometryPrecision Read more...} */ geometryPrecision: number; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#maxAllowableOffset Read more...} */ maxAllowableOffset: number; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#num Read more...} */ num: number; /** * An array of objectIds for the features in the layer/table being queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#objectIds Read more...} */ objectIds: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * Attribute fields to include in the FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#outFields Read more...} */ outFields: string[] | nullish; /** * The ID of the relationship to be queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#relationshipId Read more...} */ relationshipId: number; /** * If `true`, each feature in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnM Read more...} */ returnM: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnZ Read more...} */ returnZ: boolean; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#start Read more...} */ start: number; /** * The definition expression to be applied to the related table or layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#where Read more...} */ where: string | nullish; /** * This class defines parameters for executing queries for related records from a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html Read more...} */ constructor(properties?: RelationshipQueryProperties); /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#historicMoment Read more...} */ get historicMoment(): Date | nullish; set historicMoment(value: DateProperties | nullish); /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * Creates a deep clone of RelationshipQuery object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#clone Read more...} */ clone(): RelationshipQuery; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RelationshipQuery; } interface RelationshipQueryProperties { /** * Indicates if the service should cache the relationship query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#cacheHint Read more...} */ cacheHint?: boolean | nullish; /** * Specify the geodatabase version to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#gdbVersion Read more...} */ gdbVersion?: string | nullish; /** * Specify the number of decimal places for the geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#geometryPrecision Read more...} */ geometryPrecision?: number; /** * The historic moment to query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#historicMoment Read more...} */ historicMoment?: DateProperties | nullish; /** * The maximum allowable offset used for generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#maxAllowableOffset Read more...} */ maxAllowableOffset?: number; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#num Read more...} */ num?: number; /** * An array of objectIds for the features in the layer/table being queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#objectIds Read more...} */ objectIds?: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * Attribute fields to include in the FeatureSet. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#outFields Read more...} */ outFields?: string[] | nullish; /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * The ID of the relationship to be queried. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#relationshipId Read more...} */ relationshipId?: number; /** * If `true`, each feature in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnM Read more...} */ returnM?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#returnZ Read more...} */ returnZ?: boolean; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#start Read more...} */ start?: number; /** * The definition expression to be applied to the related table or layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RelationshipQuery.html#where Read more...} */ where?: string | nullish; } export interface RouteInfo extends Accessor, JSONSupport { } export class RouteInfo { /** * The local time offset (in minutes) for the end time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#endTimeOffset Read more...} */ endTimeOffset: number | nullish; /** * User specified route name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#name Read more...} */ name: string | nullish; /** * The local time offset (in minutes) for the start time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#startTimeOffset Read more...} */ startTimeOffset: number | nullish; /** * Total distance traveled in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#totalDistance Read more...} */ totalDistance: number | nullish; /** * Total time in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#totalDuration Read more...} */ totalDuration: number | nullish; readonly type: "route-info"; /** * A RouteInfo contains information about a solved route including the routes geometry and overall distance and time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html Read more...} */ constructor(properties?: RouteInfoProperties); /** * The end time of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#endTime Read more...} */ get endTime(): Date | nullish; set endTime(value: DateProperties | nullish); /** * Polyline representing the route's geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#geometry Read more...} */ get geometry(): Polyline | nullish; set geometry(value: PolylineProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The start time of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#startTime Read more...} */ get startTime(): Date | nullish; set startTime(value: DateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html RouteInfo} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html RouteInfo} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): RouteInfo; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteInfo; } interface RouteInfoProperties { /** * The end time of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#endTime Read more...} */ endTime?: DateProperties | nullish; /** * The local time offset (in minutes) for the end time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#endTimeOffset Read more...} */ endTimeOffset?: number | nullish; /** * Polyline representing the route's geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#geometry Read more...} */ geometry?: PolylineProperties | nullish; /** * User specified route name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#name Read more...} */ name?: string | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * The start time of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#startTime Read more...} */ startTime?: DateProperties | nullish; /** * The local time offset (in minutes) for the start time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#startTimeOffset Read more...} */ startTimeOffset?: number | nullish; /** * Total distance traveled in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#totalDistance Read more...} */ totalDistance?: number | nullish; /** * Total time in minutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteInfo.html#totalDuration Read more...} */ totalDuration?: number | nullish; } 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#accumulateAttributes Read more...} */ accumulateAttributes: string[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#apiKey Read more...} */ apiKey: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#attributeParameterValues Read more...} */ attributeParameterValues: RouteParametersAttributeParameterValue[] | nullish; /** * The language that will be used when generating travel directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsLanguage Read more...} */ directionsLanguage: string | nullish; /** * Specify the units for displaying travel distance in the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsLengthUnits Read more...} */ directionsLengthUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Define the content and verbosity of the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsOutputType Read more...} */ directionsOutputType: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only" | nullish; /** * Specify the name of the formatting style for the directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsStyleName Read more...} */ directionsStyleName: "desktop" | "navigation" | "campus" | nullish; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado * St. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsTimeAttribute Read more...} */ directionsTimeAttribute: string | nullish; /** * Use this property to specify whether the operation should reorder stops to find the optimized route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#findBestSequence Read more...} */ findBestSequence: boolean | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#impedanceAttribute Read more...} */ impedanceAttribute: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string | nullish; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * @default "true-shape" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputLines Read more...} */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#overrides Read more...} */ overrides: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#pointBarriers Read more...} */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polygonBarriers Read more...} */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polylineBarriers Read more...} */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to indicate whether the operation should keep the first stop fixed when reordering the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveFirstStop Read more...} */ preserveFirstStop: boolean | nullish; /** * Use this property to indicate whether the operation should keep the last stop fixed when reordering the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveLastStop Read more...} */ preserveLastStop: boolean | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveObjectID Read more...} */ preserveObjectID: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Use this property to restrict or permit the route from making U-turns at junctions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#restrictUTurns Read more...} */ restrictUTurns: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnBarriers Read more...} */ returnBarriers: boolean | nullish; /** * Specify whether the operation should generate driving directions for each route. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnDirections Read more...} */ returnDirections: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers: boolean | nullish; /** * Use this property to specify if the operation should return routes. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnRoutes Read more...} */ returnRoutes: boolean | nullish; /** * Use this property to specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnStops Read more...} */ returnStops: boolean | nullish; /** * Specify whether traversed edges will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedEdges Read more...} */ returnTraversedEdges: boolean | nullish; /** * Specify whether traversed junctions will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedJunctions Read more...} */ returnTraversedJunctions: boolean | nullish; /** * Specify whether traversed turns will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedTurns Read more...} */ returnTraversedTurns: boolean | nullish; /** * Include z values for the returned geometries if supported by the underlying network. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnZ Read more...} */ returnZ: boolean | nullish; /** * Indicates the time that travel should begin. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTime Read more...} */ startTime: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTime startTime} property. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTimeIsUTC Read more...} */ startTimeIsUTC: boolean | nullish; /** * Specifies the locations the output route or routes will visit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops Read more...} */ stops: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Specify whether the timeWindowStart and * timeWindowEnd property values on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} are specified in UTC * or geographically local time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#timeWindowsAreUTC Read more...} */ timeWindowsAreUTC: boolean | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#useHierarchy Read more...} */ useHierarchy: boolean | nullish; /** * Use this property to indicate whether the operation should consider time windows specified on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} * when finding the best route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#useTimeWindows Read more...} */ useTimeWindows: boolean | nullish; /** * Input parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html route}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html Read more...} */ constructor(properties?: RouteParametersProperties); /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#travelMode Read more...} */ get travelMode(): TravelMode | nullish; set travelMode(value: TravelModeProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteParameters; } interface RouteParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#accumulateAttributes Read more...} */ accumulateAttributes?: string[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#apiKey Read more...} */ apiKey?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#attributeParameterValues Read more...} */ attributeParameterValues?: RouteParametersAttributeParameterValue[] | nullish; /** * The language that will be used when generating travel directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsLanguage Read more...} */ directionsLanguage?: string | nullish; /** * Specify the units for displaying travel distance in the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsLengthUnits Read more...} */ directionsLengthUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Define the content and verbosity of the driving directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsOutputType Read more...} */ directionsOutputType?: | "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only" | nullish; /** * Specify the name of the formatting style for the directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsStyleName Read more...} */ directionsStyleName?: "desktop" | "navigation" | "campus" | nullish; /** * Set the time-based impedance attribute to display the duration of a maneuver, such as "Go northwest on Alvorado * St. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsTimeAttribute Read more...} */ directionsTimeAttribute?: string | nullish; /** * Use this property to specify whether the operation should reorder stops to find the optimized route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#findBestSequence Read more...} */ findBestSequence?: boolean | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ?: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations?: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#impedanceAttribute Read more...} */ impedanceAttribute?: | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string | nullish; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision?: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outputLines Read more...} */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#overrides Read more...} */ overrides?: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#pointBarriers Read more...} */ pointBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polygonBarriers Read more...} */ polygonBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polylineBarriers Read more...} */ polylineBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to indicate whether the operation should keep the first stop fixed when reordering the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveFirstStop Read more...} */ preserveFirstStop?: boolean | nullish; /** * Use this property to indicate whether the operation should keep the last stop fixed when reordering the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveLastStop Read more...} */ preserveLastStop?: boolean | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#preserveObjectID Read more...} */ preserveObjectID?: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Use this property to restrict or permit the route from making U-turns at junctions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#restrictUTurns Read more...} */ restrictUTurns?: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnBarriers Read more...} */ returnBarriers?: boolean | nullish; /** * Specify whether the operation should generate driving directions for each route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnDirections Read more...} */ returnDirections?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers?: boolean | nullish; /** * Use this property to specify if the operation should return routes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnRoutes Read more...} */ returnRoutes?: boolean | nullish; /** * Use this property to specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnStops Read more...} */ returnStops?: boolean | nullish; /** * Specify whether traversed edges will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedEdges Read more...} */ returnTraversedEdges?: boolean | nullish; /** * Specify whether traversed junctions will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedJunctions Read more...} */ returnTraversedJunctions?: boolean | nullish; /** * Specify whether traversed turns will be returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnTraversedTurns Read more...} */ returnTraversedTurns?: boolean | nullish; /** * Include z values for the returned geometries if supported by the underlying network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnZ Read more...} */ returnZ?: boolean | nullish; /** * Indicates the time that travel should begin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTime Read more...} */ startTime?: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTime startTime} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#startTimeIsUTC Read more...} */ startTimeIsUTC?: boolean | nullish; /** * Specifies the locations the output route or routes will visit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops Read more...} */ stops?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Specify whether the timeWindowStart and * timeWindowEnd property values on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} are specified in UTC * or geographically local time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#timeWindowsAreUTC Read more...} */ timeWindowsAreUTC?: boolean | nullish; /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#travelMode Read more...} */ travelMode?: TravelModeProperties | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#useHierarchy Read more...} */ useHierarchy?: boolean | nullish; /** * Use this property to indicate whether the operation should consider time windows specified on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops stops} * when finding the best route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#useTimeWindows Read more...} */ useTimeWindows?: boolean | nullish; } /** * An object describing the parameter values for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#attributeParameterValues attributeParameterValues} property of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html RouteParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#AttributeParameterValue Read more...} */ export interface RouteParametersAttributeParameterValue { attributeName: string; parameterName: string; value: string | number | nullish; } export interface RouteResult extends Accessor, JSONSupport { } export class RouteResult { /** * The name of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#routeName Read more...} */ routeName: string; /** * The route result from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve route.solve()} as part of a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html RouteSolveResult}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html Read more...} */ constructor(properties?: RouteResultProperties); /** * Direction lines contains a set of line features for each segment of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directionLines Read more...} */ get directionLines(): FeatureSet | nullish; set directionLines(value: FeatureSetProperties | nullish); /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directionPoints Read more...} */ get directionPoints(): FeatureSet | nullish; set directionPoints(value: FeatureSetProperties | nullish); /** * Direction are returned if * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnDirections RouteParameters.returnDirections} is set to `true` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsOutputType RouteParameters.directionsOutputType} is set * to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve route.solve()} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directions Read more...} */ get directions(): DirectionsFeatureSet | nullish; set directions(value: DirectionsFeatureSetProperties | nullish); /** * This property returns a Graphic that represent the overall path with attributes containing the total cost. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#route Read more...} */ get route(): Graphic | nullish; set route(value: GraphicProperties | nullish); /** * Array of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#stops Read more...} */ get stops(): Graphic[] | nullish; set stops(value: GraphicProperties[] | nullish); /** * This provides access to the edges that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedEdges Read more...} */ get traversedEdges(): FeatureSet | nullish; set traversedEdges(value: FeatureSetProperties | nullish); /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedJunctions Read more...} */ get traversedJunctions(): FeatureSet | nullish; set traversedJunctions(value: FeatureSetProperties | nullish); /** * This provides access to the turns that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedTurns Read more...} */ get traversedTurns(): FeatureSet | nullish; set traversedTurns(value: FeatureSetProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteResult; } interface RouteResultProperties { /** * Direction lines contains a set of line features for each segment of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directionLines Read more...} */ directionLines?: FeatureSetProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directionPoints Read more...} */ directionPoints?: FeatureSetProperties | nullish; /** * Direction are returned if * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#returnDirections RouteParameters.returnDirections} is set to `true` and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#directionsOutputType RouteParameters.directionsOutputType} is set * to `complete`, `complete-no-events`, `instructions-only', `standard` or `summary-only` in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve route.solve()} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#directions Read more...} */ directions?: DirectionsFeatureSetProperties | nullish; /** * This property returns a Graphic that represent the overall path with attributes containing the total cost. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#route Read more...} */ route?: GraphicProperties | nullish; /** * The name of the route. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#routeName Read more...} */ routeName?: string; /** * Array of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#stops Read more...} */ stops?: GraphicProperties[] | nullish; /** * This provides access to the edges that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedEdges Read more...} */ traversedEdges?: FeatureSetProperties | nullish; /** * This provides access to the junctions that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedJunctions Read more...} */ traversedJunctions?: FeatureSetProperties | nullish; /** * This provides access to the turns that are traversed while solving a network analysis layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html#traversedTurns Read more...} */ traversedTurns?: FeatureSetProperties | nullish; } export interface RouteSolveResult extends Accessor, JSONSupport { } export class RouteSolveResult { /** * The results from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-route.html#solve route.solve()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html Read more...} */ constructor(properties?: RouteSolveResultProperties); /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#messages Read more...} */ get messages(): NAMessage[] | nullish; set messages(value: NAMessageProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#pointBarriers Read more...} */ get pointBarriers(): Graphic[] | nullish; set pointBarriers(value: GraphicProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#polygonBarriers Read more...} */ get polygonBarriers(): Graphic[] | nullish; set polygonBarriers(value: GraphicProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#polylineBarriers Read more...} */ get polylineBarriers(): Graphic[] | nullish; set polylineBarriers(value: GraphicProperties[] | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html route results}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#routeResults Read more...} */ get routeResults(): RouteResult[]; set routeResults(value: RouteResultProperties[]); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): RouteSolveResult; } interface RouteSolveResultProperties { /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#messages Read more...} */ messages?: NAMessageProperties[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#pointBarriers Read more...} */ pointBarriers?: GraphicProperties[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#polygonBarriers Read more...} */ polygonBarriers?: GraphicProperties[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#polylineBarriers Read more...} */ polylineBarriers?: GraphicProperties[] | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteResult.html route results}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteSolveResult.html#routeResults Read more...} */ 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#accumulateAttributes Read more...} */ accumulateAttributes: | ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#apiKey Read more...} */ apiKey: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#attributeParameterValues Read more...} */ attributeParameterValues: ServiceAreaParametersAttributeParameterValue[] | nullish; /** * Use this parameter to specify the size and number of service areas to generate for each facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#defaultBreaks Read more...} */ defaultBreaks: number[] | nullish; /** * An array of network source names to not use when generating polygons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#excludeSourcesFromPolygons Read more...} */ excludeSourcesFromPolygons: string[] | nullish; /** * The input locations around which service areas are generated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#facilities Read more...} */ facilities: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecision Read more...} */ geometryPrecision: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#impedanceAttribute Read more...} */ impedanceAttribute: string | nullish; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges Read more...} */ mergeSimilarPolygonRanges: boolean; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputLines Read more...} */ outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * This parameter sets whether service area polygons should be returned and to what detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputPolygons Read more...} */ outputPolygons: "none" | "simplified" | "detailed" | nullish; /** * Specifies whether the service area lines from different facilities can overlap each other. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overlapLines Read more...} */ overlapLines: boolean | nullish; /** * Specifies whether the service areas from different facilities can overlap each other. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overlapPolygons Read more...} */ overlapPolygons: boolean | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overrides Read more...} */ overrides: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#pointBarriers Read more...} */ pointBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polygonBarriers Read more...} */ polygonBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polylineBarriers Read more...} */ polylineBarriers: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#preserveObjectID Read more...} */ preserveObjectID: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Specifies how U-Turns should be handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#restrictUTurns Read more...} */ restrictUTurns: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Determines if facilities will be returned by the service. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnFacilities Read more...} */ returnFacilities: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPointBarriers Read more...} */ returnPointBarriers: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers: boolean | nullish; /** * Specifies whether the service area lines should be split at break values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#splitLinesAtBreaks Read more...} */ splitLinesAtBreaks: boolean | nullish; /** * Specifies whether multiple service areas around a facility are created as disks or rings. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#splitPolygonsAtBreaks Read more...} */ splitPolygonsAtBreaks: boolean | nullish; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDay Read more...} */ timeOfDay: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDay timeOfDay} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDayIsUTC Read more...} */ timeOfDayIsUTC: boolean | nullish; /** * Specifies whether the direction of travel used to generate the service area polygons is toward or away from the * facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#travelDirection Read more...} */ travelDirection: "from-facility" | "to-facility" | nullish; /** * Specifies whether the service areas are trimmed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimOuterPolygon Read more...} */ trimOuterPolygon: boolean | nullish; /** * The property defines the distance that can be reached from the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistance Read more...} */ trimPolygonDistance: number | nullish; /** * Specifies the units of the value specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistance trimPolygonDistance}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistanceUnits Read more...} */ trimPolygonDistanceUnits: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#useHierarchy Read more...} */ useHierarchy: boolean | nullish; /** * ServiceAreaParameters provides the input parameters for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-serviceArea.html serviceArea} request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html Read more...} */ constructor(properties?: ServiceAreaParametersProperties); /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#travelMode Read more...} */ get travelMode(): TravelMode | nullish; set travelMode(value: TravelModeProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ServiceAreaParameters; } interface ServiceAreaParametersProperties { /** * Use this property to specify whether the operation should accumulate values other than the value specified for * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#impedanceAttribute impedanceAttribute}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#accumulateAttributes Read more...} */ accumulateAttributes?: | ( | "kilometers" | "miles" | "minutes" | "travel-time" | "truck-minutes" | "truck-travel-time" | "walk-time" | string )[] | nullish; /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#apiKey Read more...} */ apiKey?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#attributeParameterValues Read more...} */ attributeParameterValues?: ServiceAreaParametersAttributeParameterValue[] | nullish; /** * Use this parameter to specify the size and number of service areas to generate for each facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#defaultBreaks Read more...} */ defaultBreaks?: number[] | nullish; /** * An array of network source names to not use when generating polygons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#excludeSourcesFromPolygons Read more...} */ excludeSourcesFromPolygons?: string[] | nullish; /** * The input locations around which service areas are generated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#facilities Read more...} */ facilities?: DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecision Read more...} */ geometryPrecision?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecisionM Read more...} */ geometryPrecisionM?: number | nullish; /** * Use this property to specify the number of decimal places in the response geometries returned by a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#geometryPrecisionZ Read more...} */ geometryPrecisionZ?: number | nullish; /** * Specify whether invalid input locations should be ignored when finding the best solution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#ignoreInvalidLocations Read more...} */ ignoreInvalidLocations?: boolean | nullish; /** * Specifies the impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#impedanceAttribute Read more...} */ impedanceAttribute?: string | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#mergeSimilarPolygonRanges Read more...} */ mergeSimilarPolygonRanges?: boolean; /** * Use this property to specify by how much you want to simplify the route geometry returned by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecision Read more...} */ outputGeometryPrecision?: number | nullish; /** * Use this property to specify the units for the value specified for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecision outputGeometryPrecision} parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputGeometryPrecisionUnits Read more...} */ outputGeometryPrecisionUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Use this property to specify the type of route features that are output by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputLines Read more...} */ outputLines?: "none" | "straight" | "true-shape" | "true-shape-with-measure" | nullish; /** * This parameter sets whether service area polygons should be returned and to what detail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outputPolygons Read more...} */ outputPolygons?: "none" | "simplified" | "detailed" | nullish; /** * Use this property to specify the spatial reference of the geometries, such as line or point features, returned by * a solve operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * Specifies whether the service area lines from different facilities can overlap each other. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overlapLines Read more...} */ overlapLines?: boolean | nullish; /** * Specifies whether the service areas from different facilities can overlap each other. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overlapPolygons Read more...} */ overlapPolygons?: boolean | nullish; /** * Specify additional settings that can influence the behavior of the solver when finding solutions for the network * analysis problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#overrides Read more...} */ overrides?: any | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#pointBarriers Read more...} */ pointBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polygonBarriers Read more...} */ polygonBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * Use this property to specify one or more lines that prohibit travel anywhere the lines intersect the streets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polylineBarriers Read more...} */ polylineBarriers?: Collection | DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#preserveObjectID Read more...} */ preserveObjectID?: boolean | nullish; /** * Use this property to specify which restrictions should be honored by the operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#restrictionAttributes Read more...} */ 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 )[] | nullish; /** * Specifies how U-Turns should be handled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#restrictUTurns Read more...} */ restrictUTurns?: | "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections" | nullish; /** * Determines if facilities will be returned by the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnFacilities Read more...} */ returnFacilities?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#pointBarriers point barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPointBarriers Read more...} */ returnPointBarriers?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polygonBarriers polygon barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPolygonBarriers Read more...} */ returnPolygonBarriers?: boolean | nullish; /** * Specify whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#polylineBarriers polyline barriers} will be returned by the routing operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#returnPolylineBarriers Read more...} */ returnPolylineBarriers?: boolean | nullish; /** * Specifies whether the service area lines should be split at break values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#splitLinesAtBreaks Read more...} */ splitLinesAtBreaks?: boolean | nullish; /** * Specifies whether multiple service areas around a facility are created as disks or rings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#splitPolygonsAtBreaks Read more...} */ splitPolygonsAtBreaks?: boolean | nullish; /** * Specify the time and date to depart from or arrive at incidents or facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDay Read more...} */ timeOfDay?: Date | "now" | nullish; /** * Specify the time zone or zones of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDay timeOfDay} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#timeOfDayIsUTC Read more...} */ timeOfDayIsUTC?: boolean | nullish; /** * Specifies whether the direction of travel used to generate the service area polygons is toward or away from the * facilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#travelDirection Read more...} */ travelDirection?: "from-facility" | "to-facility" | nullish; /** * A travel mode represents a means of transportation, such as driving or walking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#travelMode Read more...} */ travelMode?: TravelModeProperties | nullish; /** * Specifies whether the service areas are trimmed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimOuterPolygon Read more...} */ trimOuterPolygon?: boolean | nullish; /** * The property defines the distance that can be reached from the network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistance Read more...} */ trimPolygonDistance?: number | nullish; /** * Specifies the units of the value specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistance trimPolygonDistance}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#trimPolygonDistanceUnits Read more...} */ trimPolygonDistanceUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown" | nullish; /** * Specify whether hierarchy should be used when finding the shortest paths. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#useHierarchy Read more...} */ useHierarchy?: boolean | nullish; } /** * An object describing the parameter values for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#attributeParameterValues attributeParameterValues} property of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html ServiceAreaParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaParameters.html#AttributeParameterValue Read more...} */ export interface ServiceAreaParametersAttributeParameterValue { attributeName: string; parameterName: string; value: string | number | nullish; } export interface ServiceAreaSolveResult extends Accessor, JSONSupport { } export class ServiceAreaSolveResult { /** * The result from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-serviceArea.html serviceArea}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html Read more...} */ constructor(properties?: ServiceAreaSolveResultProperties); /** * This provides access to the output facilities from a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#facilities Read more...} */ get facilities(): FeatureSet | nullish; set facilities(value: FeatureSetProperties | nullish); /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#messages Read more...} */ get messages(): NAMessage[] | nullish; set messages(value: NAMessageProperties[] | nullish); /** * A set of features representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#pointBarriers Read more...} */ get pointBarriers(): FeatureSet | nullish; set pointBarriers(value: FeatureSetProperties | nullish); /** * A set of features representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#polygonBarriers Read more...} */ get polygonBarriers(): FeatureSet | nullish; set polygonBarriers(value: FeatureSetProperties | nullish); /** * A set of features representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#polylineBarriers Read more...} */ get polylineBarriers(): FeatureSet | nullish; set polylineBarriers(value: FeatureSetProperties | nullish); /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#serviceAreaPolygons Read more...} */ get serviceAreaPolygons(): FeatureSet | nullish; set serviceAreaPolygons(value: FeatureSetProperties | nullish); /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#serviceAreaPolylines Read more...} */ get serviceAreaPolylines(): FeatureSet | nullish; set serviceAreaPolylines(value: FeatureSetProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ServiceAreaSolveResult; } interface ServiceAreaSolveResultProperties { /** * This provides access to the output facilities from a closest facility analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#facilities Read more...} */ facilities?: FeatureSetProperties | nullish; /** * An array of processing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-NAMessage.html messages} generated by the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#messages Read more...} */ messages?: NAMessageProperties[] | nullish; /** * A set of features representing point barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#pointBarriers Read more...} */ pointBarriers?: FeatureSetProperties | nullish; /** * A set of features representing polygon barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#polygonBarriers Read more...} */ polygonBarriers?: FeatureSetProperties | nullish; /** * A set of features representing polyline barriers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#polylineBarriers Read more...} */ polylineBarriers?: FeatureSetProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#serviceAreaPolygons Read more...} */ serviceAreaPolygons?: FeatureSetProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-ServiceAreaSolveResult.html#serviceAreaPolylines Read more...} */ serviceAreaPolylines?: FeatureSetProperties | nullish; } export interface StatisticDefinition extends Accessor, JSONSupport { } export class StatisticDefinition { /** * Defines the field for which statistics will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#onStatisticField Read more...} */ onStatisticField: string | nullish; /** * Specifies the output field name for the requested statistic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#outStatisticFieldName Read more...} */ outStatisticFieldName: string | nullish; /** * The parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType percentile statistics}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticParameters Read more...} */ statisticParameters: StatisticDefinitionStatisticParameters | nullish; /** * Defines the type of statistic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType Read more...} */ statisticType: | "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "exceedslimit" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | nullish; /** * This class defines the parameters for querying a layer or layer view for statistics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html Read more...} */ constructor(properties?: StatisticDefinitionProperties); /** * Creates a deep clone of StatisticDefinition object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#clone Read more...} */ clone(): StatisticDefinition; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): StatisticDefinition; } interface StatisticDefinitionProperties { /** * Defines the field for which statistics will be calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#onStatisticField Read more...} */ onStatisticField?: string | nullish; /** * Specifies the output field name for the requested statistic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#outStatisticFieldName Read more...} */ outStatisticFieldName?: string | nullish; /** * The parameters for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType percentile statistics}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticParameters Read more...} */ statisticParameters?: StatisticDefinitionStatisticParameters | nullish; /** * Defines the type of statistic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-StatisticDefinition.html#statisticType Read more...} */ statisticType?: | "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "exceedslimit" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | nullish; } export interface StatisticDefinitionStatisticParameters { value: number; orderBy?: "ASC" | "DESC"; } export interface Stop extends Accessor, JSONSupport { } export class Stop { /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#arriveTimeOffset Read more...} */ arriveTimeOffset: number | nullish; /** * Specify the direction a vehicle may arrive at and depart from the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#curbApproach Read more...} */ curbApproach: "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn" | nullish; /** * The local time offset in minutes for the departure time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#departTimeOffset Read more...} */ departTimeOffset: number | nullish; locationType: "stop" | "waypoint" | "break" | nullish; /** * The name of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#name Read more...} */ name: string | nullish; /** * If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify * with this attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#sequence Read more...} */ sequence: number | nullish; /** * Indicates the status of the point with respect to its location on the network and the outcome of the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#status Read more...} */ status: | "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest" | nullish; readonly type: "stop"; /** * A stop respresents the start, end, or midpoint of a route in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#stops RouteLayer} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-RouteParameters.html#stops RouteParameters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html Read more...} */ constructor(properties?: StopProperties); /** * The date and time value indicating the arrival time at the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#arriveTime Read more...} */ get arriveTime(): Date | nullish; set arriveTime(value: DateProperties | nullish); /** * The date and time value indicating the departure time from the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#departTime Read more...} */ get departTime(): Date | nullish; set departTime(value: DateProperties | nullish); /** * The point location of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#geometry Read more...} */ get geometry(): Point | nullish; set geometry(value: PointProperties | nullish); /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * The latest time the route can visit the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#timeWindowEnd Read more...} */ get timeWindowEnd(): Date | nullish; set timeWindowEnd(value: DateProperties | nullish); /** * The earliest time the route can visit the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#timeWindowStart Read more...} */ get timeWindowStart(): Date | nullish; set timeWindowStart(value: DateProperties | nullish); /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html Stop} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#toGraphic Read more...} */ toGraphic(): Graphic; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#toJSON Read more...} */ toJSON(): any; /** * Creates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html Stop} from the parsed {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic A Graphic instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#fromGraphic Read more...} */ static fromGraphic(graphic?: Graphic): Stop; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Stop; } interface StopProperties { /** * The date and time value indicating the arrival time at the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#arriveTime Read more...} */ arriveTime?: DateProperties | nullish; /** * The local time offset (in minutes) for the arrival time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#arriveTimeOffset Read more...} */ arriveTimeOffset?: number | nullish; /** * Specify the direction a vehicle may arrive at and depart from the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#curbApproach Read more...} */ curbApproach?: "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn" | nullish; /** * The date and time value indicating the departure time from the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#departTime Read more...} */ departTime?: DateProperties | nullish; /** * The local time offset in minutes for the departure time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#departTimeOffset Read more...} */ departTimeOffset?: number | nullish; /** * The point location of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#geometry Read more...} */ geometry?: PointProperties | nullish; locationType?: "stop" | "waypoint" | "break" | nullish; /** * The name of the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#name Read more...} */ name?: string | nullish; /** * The template for displaying content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when the graphic is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * If the findBestSequence parameter is set to false, the output routes will visit the stops in the order you specify * with this attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#sequence Read more...} */ sequence?: number | nullish; /** * Indicates the status of the point with respect to its location on the network and the outcome of the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#status Read more...} */ status?: | "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest" | nullish; /** * The latest time the route can visit the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#timeWindowEnd Read more...} */ timeWindowEnd?: DateProperties | nullish; /** * The earliest time the route can visit the stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Stop.html#timeWindowStart Read more...} */ timeWindowStart?: DateProperties | nullish; } export interface TopFeaturesQuery extends Accessor, JSONSupport, QueryMixin { } export class TopFeaturesQuery { /** * Indicates if the service should cache the query results. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#cacheHint Read more...} */ declare cacheHint: QueryMixin["cacheHint"]; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#distance Read more...} */ declare distance: QueryMixin["distance"]; /** * Specifies the number of decimal places for geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometryPrecision Read more...} */ geometryPrecision: number; /** * The maximum distance in units of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outSpatialReference outSpatialReference} used for * generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#maxAllowableOffset Read more...} */ maxAllowableOffset: number; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#num Read more...} */ num: number | nullish; /** * An array of ObjectIDs to be used to query for features in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#objectIds Read more...} */ objectIds: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * Attribute fields to include in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outFields Read more...} */ outFields: string[] | nullish; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry Read more...} */ returnGeometry: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnM Read more...} */ returnM: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnZ Read more...} */ returnZ: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry geometry}. * * @default intersects * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#spatialRelationship Read more...} */ declare spatialRelationship: QueryMixin["spatialRelationship"]; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#start Read more...} */ start: number | nullish; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#distance distance} is specified in spatial queries. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#units Read more...} */ declare units: QueryMixin["units"]; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#where Read more...} */ declare where: QueryMixin["where"]; /** * This class defines parameters for executing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#queryTopFeatures top features queries} * from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html Read more...} */ constructor(properties?: TopFeaturesQueryProperties); /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The `topFilter` parameter is used to set the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#groupByFields groupByFields}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#orderByFields orderByFields}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#topCount topCount} criteria used in generating the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter Read more...} */ get topFilter(): TopFilter; set topFilter(value: TopFilterProperties); /** * Creates a deep clone of TopFeaturesQuery object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#clone Read more...} */ clone(): TopFeaturesQuery; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TopFeaturesQuery; } interface TopFeaturesQueryProperties extends QueryMixinProperties { /** * Indicates if the service should cache the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#cacheHint Read more...} */ cacheHint?: QueryMixinProperties["cacheHint"]; /** * Specifies a search distance from a given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry geometry} in a spatial query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#distance Read more...} */ distance?: QueryMixinProperties["distance"]; /** * The geometry to apply to the spatial filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * Specifies the number of decimal places for geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometryPrecision Read more...} */ geometryPrecision?: number; /** * The maximum distance in units of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outSpatialReference outSpatialReference} used for * generalizing geometries returned by the query operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#maxAllowableOffset Read more...} */ maxAllowableOffset?: number; /** * The number of features to retrieve. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#num Read more...} */ num?: number | nullish; /** * An array of ObjectIDs to be used to query for features in a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#objectIds Read more...} */ objectIds?: (number | string)[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * Attribute fields to include in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outFields Read more...} */ outFields?: string[] | nullish; /** * The spatial reference for the returned geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * If `true`, each feature in the returned {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} includes the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry Read more...} */ returnGeometry?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry returnGeometry} is `true`, then m-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnM Read more...} */ returnM?: boolean; /** * If `true`, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnGeometry returnGeometry} is `true`, then z-values are included in the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#returnZ Read more...} */ returnZ?: boolean; /** * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#geometry geometry}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#spatialRelationship Read more...} */ spatialRelationship?: QueryMixinProperties["spatialRelationship"]; /** * The zero-based index indicating where to begin retrieving features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#start Read more...} */ start?: number | nullish; /** * A time extent for a temporal query against {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#timeInfo time-aware layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The `topFilter` parameter is used to set the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#groupByFields groupByFields}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#orderByFields orderByFields}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#topCount topCount} criteria used in generating the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#topFilter Read more...} */ topFilter?: TopFilterProperties; /** * The unit for calculating the buffer distance when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#distance distance} is specified in spatial queries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#units Read more...} */ units?: QueryMixinProperties["units"]; /** * A where clause for the query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFeaturesQuery.html#where Read more...} */ where?: QueryMixinProperties["where"]; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#groupByFields Read more...} */ groupByFields: string[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * Defines the number of features to be returned from the top features query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#topCount Read more...} */ topCount: number | nullish; /** * This class defines the top filter parameters for executing top features queries for features from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html Read more...} */ constructor(properties?: TopFilterProperties); /** * Creates a deep clone of TopFilter object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#clone Read more...} */ clone(): TopFilter; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#groupByFields Read more...} */ groupByFields?: string[] | nullish; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * Defines the number of features to be returned from the top features query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TopFilter.html#topCount Read more...} */ topCount?: number | nullish; } export interface TravelMode extends Accessor, JSONSupport, Clonable { } export class TravelMode { /** * Lists the parameterized attributes used by the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#attributeParameterValues Read more...} */ attributeParameterValues: TravelModeAttributeParameterValues[]; /** * A short text description of the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#description Read more...} */ description: string | nullish; /** * Indicates the distance-based cost attribute for reporting directions and for solving vehicle routing problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#distanceAttributeName Read more...} */ distanceAttributeName: string; /** * The unique identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#id Read more...} */ id: string; /** * The network cost attribute used as impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#impedanceAttributeName Read more...} */ impedanceAttributeName: string; /** * The unique name of the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#name Read more...} */ name: string; /** * The list of the restriction attributes used when solving network analysis problems with this travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#restrictionAttributeNames Read more...} */ restrictionAttributeNames: string[]; /** * Specifies whether the travel mode generalizes the geometry of analysis results and by how much. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationTolerance Read more...} */ simplificationTolerance: number; /** * The linear units associated with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationTolerance simplificationTolerance}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationToleranceUnits Read more...} */ simplificationToleranceUnits: LengthUnit | "decimal-degrees" | "points" | "unknown"; /** * Indicates the time-based cost attribute for reporting directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#timeAttributeName Read more...} */ timeAttributeName: string; /** * Indicates the category of travel or vehicle represented by this travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#type Read more...} */ type: "automobile" | "truck" | "walk" | "other"; /** * Indicates whether the travel mode uses a hierarchy attribute while performing the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#useHierarchy Read more...} */ useHierarchy: boolean; /** * Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#uturnAtJunctions Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html Read more...} */ constructor(properties?: TravelModeProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TravelMode; } interface TravelModeProperties { /** * Lists the parameterized attributes used by the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#attributeParameterValues Read more...} */ attributeParameterValues?: TravelModeAttributeParameterValues[]; /** * A short text description of the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#description Read more...} */ description?: string | nullish; /** * Indicates the distance-based cost attribute for reporting directions and for solving vehicle routing problems. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#distanceAttributeName Read more...} */ distanceAttributeName?: string; /** * The unique identifier. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#id Read more...} */ id?: string; /** * The network cost attribute used as impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#impedanceAttributeName Read more...} */ impedanceAttributeName?: string; /** * The unique name of the travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#name Read more...} */ name?: string; /** * The list of the restriction attributes used when solving network analysis problems with this travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#restrictionAttributeNames Read more...} */ restrictionAttributeNames?: string[]; /** * Specifies whether the travel mode generalizes the geometry of analysis results and by how much. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationTolerance Read more...} */ simplificationTolerance?: number; /** * The linear units associated with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationTolerance simplificationTolerance}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#simplificationToleranceUnits Read more...} */ simplificationToleranceUnits?: LengthUnit | "decimal-degrees" | "points" | "unknown"; /** * Indicates the time-based cost attribute for reporting directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#timeAttributeName Read more...} */ timeAttributeName?: string; /** * Indicates the category of travel or vehicle represented by this travel mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#type Read more...} */ type?: "automobile" | "truck" | "walk" | "other"; /** * Indicates whether the travel mode uses a hierarchy attribute while performing the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#useHierarchy Read more...} */ useHierarchy?: boolean; /** * Indicates how the U-turns at junctions that could occur during network traversal are handled by the solver. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html#uturnAtJunctions Read more...} */ uturnAtJunctions?: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"; } export interface TravelModeAttributeParameterValues { attributeName: string; parameterName: string; value: string | number | nullish; } export interface TrimExtendParameters extends Accessor, JSONSupport { } export class TrimExtendParameters { /** * A flag used with the `trimExtend` operation. * * @default "default-curve-extension" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#extendHow Read more...} */ extendHow: | "default-curve-extension" | "relocate-ends" | "keep-end-attributes" | "no-end-attributes" | "no-extend-at-from" | "no-extend-at-to"; /** * Used to set the parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-geometryService.html#trimExtend geometryService.trimExtend} operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html Read more...} */ constructor(properties?: TrimExtendParametersProperties); /** * The array of polylines to trim or extend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#polylines Read more...} */ get polylines(): Polyline[] | nullish; set polylines(value: PolylineProperties[] | nullish); /** * A polyline used as a guide for trimming or extending input polylines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#trimExtendTo Read more...} */ get trimExtendTo(): Polyline | nullish; set trimExtendTo(value: PolylineProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TrimExtendParameters; } interface TrimExtendParametersProperties { /** * A flag used with the `trimExtend` operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#extendHow Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#polylines Read more...} */ polylines?: PolylineProperties[] | nullish; /** * A polyline used as a guide for trimming or extending input polylines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TrimExtendParameters.html#trimExtendTo Read more...} */ trimExtendTo?: PolylineProperties | nullish; } /** * Represents [symbol service](https://doc.geoscene.cn/rest/services-reference/enterprise/symbol-server.htm) resources exposed by the GeoScene REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html Read more...} */ interface symbolService { /** * Converts a [Scalable Vector Graphic](https://pro.geoscene.cn/zh/pro-app/latest/help/mapping/layer-properties/scalable-vector-graphics-support.htm) (SVG) to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol}. * * @param url URL to the GeoScene Server REST resource that represents a symbol service. * @param params Input parameters for converting an SVG to CIM Symbol. * @param requestOptions Additional {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-request.html#request options} to be used for the data request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html#generateSymbol Read more...} */ generateSymbol(url: string, params: GenerateSymbolParameters, requestOptions?: RequestOptions): Promise; } export const symbolService: symbolService; /** * Input parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html#generateSymbol generateSymbol} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html#GenerateSymbolParameters Read more...} */ export interface GenerateSymbolParameters { svgImage?: string | FormData | HTMLFormElement; } /** * The response of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html#generateSymbol generateSymbol} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-symbolService.html#GenerateSymbolResponse Read more...} */ export interface GenerateSymbolResponse { symbol: CIMSymbol; } /** * Function that suggests a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fixedBinLevel fixedBinLevel} in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html FeatureReductionBinning} visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-binLevel.html Read more...} */ interface binLevel { /** * Generates a suggested {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#fixedBinLevel fixedBinLevel} * for a binning visualization based on the view scale at the time this method is called. * * @param params See the table below for details about parameters that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-binLevel.html#binLevel Read more...} */ binLevel(params: binLevelBinLevelParams): Promise; } const __binLevelMapped: binLevel; export const binLevel: typeof __binLevelMapped.binLevel; export interface binLevelBinLevelParams { view: MapView; } /** * Function for determining suggested {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#minScale min} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#maxScale max} scale ranges for an input layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-scaleRange.html Read more...} */ interface scaleRange { /** * Generates a suggested scale range (i.e. * * @param params See the table below for details about parameters that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-scaleRange.html#scaleRange Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-scaleRange.html#scaleRange scaleRange()} * function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-scaleRange.html#ScaleRangeResult Read more...} */ export interface ScaleRangeResult { minScale: number; maxScale: number; } export interface scaleRangeScaleRangeParams { layer: | FeatureLayer | SceneLayer | CSVLayer | OGCFeatureLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; sampleSize?: number; filter?: FeatureFilter; forBinning?: boolean; signal?: AbortSignal | nullish; } /** * Function for determining the suggested `minSize` and `maxSize` of a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons scale-dependent size visual variable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-sizeRange.html Read more...} */ interface sizeRange { /** * Generates a suggested size range (i.e. * * @param params See the table below for details about parameters that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-sizeRange.html#sizeRange Read more...} */ sizeRange(params: sizeRangeSizeRangeParams): Promise; } const __sizeRangeMapped: sizeRange; export const sizeRange: typeof __sizeRangeMapped.sizeRange; /** * The suggested `minSize` and `maxSize` * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ScaleDependentStops size stops} * generated from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-sizeRange.html#sizeRange sizeRange()} function to apply to the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html#ScaleDependentIcons scale-dependent size visual variable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-heuristics-sizeRange.html#SizeRangeResult Read more...} */ export interface SizeRangeResult { minSize: ScaleDependentStops; maxSize: ScaleDependentStops; } export interface sizeRangeSizeRangeParams { layer: | FeatureLayer | SceneLayer | CSVLayer | OGCFeatureLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; filter?: FeatureFilter; forBinning?: boolean; signal?: AbortSignal | nullish; } /** * This object contains a helper method for generating default labels to be set on * a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelingInfo binning configuration}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-bins.html Read more...} */ interface bins { /** * Generates default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelingInfo labelingInfo} * schemes to be set on a FeatureLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureReduction featureReduction} property. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-bins.html#getLabelSchemes Read more...} */ getLabelSchemes(params: binsGetLabelSchemesParams): Promise; } export const bins: bins; export interface binsGetLabelSchemesParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer; field?: string; renderer?: RendererUnion; } /** * Contains suggested labelingInfo to be set on the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html#labelingInfo featureReduction.labelingInfo}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-bins.html#Scheme Read more...} */ export interface Scheme { name: string; fieldName: string; labelingInfo: LabelClass[]; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-bins.html#getLabelSchemes getLabelSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-bins.html#Schemes Read more...} */ export interface Schemes { primaryScheme: Scheme; secondarySchemes: Scheme[]; } /** * This object contains a helper method for generating default labels to be set on * a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelingInfo cluster configuration}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-clusters.html Read more...} */ interface clusters { /** * Generates default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelingInfo labelingInfo} * schemes to be set on a FeatureLayer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#featureReduction featureReduction} configuration. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-clusters.html#getLabelSchemes Read more...} */ getLabelSchemes(params: clustersGetLabelSchemesParams): Promise; } export const clusters: clusters; export interface clustersGetLabelSchemesParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer; view: MapView; field?: string; renderer?: SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | PieChartRenderer; } /** * Contains a suggested labelingInfo to be set on the layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#labelingInfo featureReduction.labelingInfo}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-clusters.html#Scheme Read more...} */ export interface clustersScheme { name: string; fieldName: string; labelingInfo: LabelClass[]; clusterMinSize: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-clusters.html#getLabelSchemes getLabelSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-labels-clusters.html#Schemes Read more...} */ export interface clustersSchemes { primaryScheme: clustersScheme; secondarySchemes: clustersScheme[]; } /** * This object contains helper methods for generating popup templates to be set on * a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupTemplate FeatureReductionCluster}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-clusters.html Read more...} */ interface popupClusters { /** * Returns one or more suggested default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html popupTemplates} for a given * layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html#popupTemplate FeatureReductionCluster} * configuration. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-clusters.html#getTemplates Read more...} */ getTemplates(params: clustersGetTemplatesParams): Promise; } export const popupClusters: popupClusters; export interface clustersGetTemplatesParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer; renderer: | SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | PieChartRenderer | DotDensityRenderer | DictionaryRenderer; } /** * This object contains helper methods for generating popup templates to be set on * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#popupTemplate layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-templates.html Read more...} */ interface templates { /** * Returns one or more suggested {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html popupTemplates} for a given layer based on * its renderer. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-templates.html#getTemplates Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-templates.html#Template Read more...} */ export interface Template { name: string; title: string; value: PopupTemplate; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-templates.html#getTemplates getTemplates()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-popup-templates.html#Templates Read more...} */ export interface Templates { primaryTemplate: Template; secondaryTemplates: Template[]; } export interface templatesGetTemplatesParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; renderer?: RendererUnion; } /** * This object contains helper methods for generating class breaks visualizations for raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-classBreaks.html Read more...} */ interface classBreaks { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} used to render imagery data. * * @param params Input parameters for generating a classed color visualization for raster data returned from the cell value or a given field. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-classBreaks.html#createRenderer Read more...} */ createRenderer(params: classBreaksCreateRendererParams): Promise; } export const classBreaks: classBreaks; export interface classBreaksCreateRendererParams { layer: ImageryLayer | ImageryTileLayer | WCSLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; field?: string; classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation" | "defined-interval"; variableName?: string; numClasses?: number; colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; colors?: number[][]; definedInterval?: number; signal?: AbortSignal | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-classBreaks.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-classBreaks.html#RasterClassBreaksResult Read more...} */ export interface RasterClassBreaksResult { renderer: ClassBreaksRenderer; classBreaksResult: ClassBreaksResult; } /** * This object contains helper methods for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html RasterColormapRenderer} for raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-colormap.html Read more...} */ interface colormap { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterColormapRenderer.html RasterColormapRenderer} used to render imagery data. * * @param params Input parameters for generating a colormap visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-colormap.html#createRenderer Read more...} */ createRenderer(params: colormapCreateRendererParams): Promise; } export const colormap: colormap; export interface colormapCreateRendererParams { layer: ImageryLayer | ImageryTileLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; signal?: AbortSignal | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-colormap.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-colormap.html#RasterColormapResult Read more...} */ export interface RasterColormapResult { renderer: RasterColormapRenderer; } /** * This object contains helper methods for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html FlowRenderer} for a * `Vector-UV` or `Vector-MagDir` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html Read more...} */ interface flow { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html FlowRenderer} to display raster data with stream lines. * * @param params Input parameters for generating a flow visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html#createRenderer Read more...} */ createRenderer(params: flowCreateRendererParams): Promise; } export const flow: flow; export interface flowCreateRendererParams { layer: ImageryLayer | ImageryTileLayer; view?: MapView; theme?: "flow-line" | "wave-front"; includeColorVariable?: boolean; includeSizeVariable?: boolean; includeOpacityVariable?: boolean; legendOptions?: flowCreateRendererParamsLegendOptions; flowScheme?: FlowScheme; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; flowRepresentation?: "flow-from" | "flow-to"; signal?: AbortSignal | nullish; } export interface flowCreateRendererParamsLegendOptions { title?: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-flow.html#FlowRendererResult Read more...} */ export interface FlowRendererResult { renderer: FlowRenderer; flowScheme: FlowScheme; visualVariables: VisualVariable[]; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; layerEffect: string; } /** * This object contains helper methods for generating an RGB {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html stretch visualization} for raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-rgb.html Read more...} */ interface rgb { /** * Generates an RGB {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html RasterStretchRenderer} to render three selected bands into * red, green, and blue color channels. * * @param params Input parameters for generating a RGB stretch visualization. See the table below for details of each parameter. The `colorRamp`, `gamma`, `useGamma`, and `dynamicRangeAdjustment` parameters are not related to RGB band ID selection or stretch type. Pass them in to preserve the existing settings if desired. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-rgb.html#createRenderer Read more...} */ createRenderer(params: rgbCreateRendererParams): Promise; } export const rgb: rgb; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-rgb.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-rgb.html#RasterRGBResult Read more...} */ export interface RasterRGBResult { renderer: RasterStretchRenderer; rgbBandIds?: [number, number, number] | nullish; } export interface rgbCreateRendererParams { layer: ImageryLayer | ImageryTileLayer | WCSLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; stretchType?: "none" | "min-max" | "standard-deviation" | "histogram-equalization" | "percent-clip" | "sigmoid"; rgbBandIds?: [number, number, number]; gamma?: [number, number, number]; useGamma?: boolean; dynamicRangeAdjustment?: boolean; estimateStatistics?: boolean; signal?: AbortSignal | nullish; } /** * This object contains helper methods for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html RasterShadedReliefRenderer} to render elevation values in raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-shadedRelief.html Read more...} */ interface shadedRelief { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterShadedReliefRenderer.html RasterShadedReliefRenderer} to render elevation data. * * @param params Input parameters for generating a shaded relief visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-shadedRelief.html#createRenderer Read more...} */ createRenderer(params: shadedReliefCreateRendererParams): Promise; } export const shadedRelief: shadedRelief; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-shadedRelief.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-shadedRelief.html#RasterShadedReliefResult Read more...} */ export interface RasterShadedReliefResult { renderer: RasterShadedReliefRenderer; } export interface shadedReliefCreateRendererParams { layer: ImageryLayer | ImageryTileLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; hillshadeType?: "traditional" | "multi-directional"; scalingType?: "none" | "adjusted"; colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; signal?: AbortSignal | nullish; } /** * This object contains helper methods for generating a single-band {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html stretch visualization} for raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-stretch.html Read more...} */ interface stretch { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-RasterStretchRenderer.html RasterStretchRenderer} to render data from a single raster band. * * @param params Input parameters for generating a single-band stretch visualization. See the table below for details of each parameter. The `colorRamp`, `gamma`, `useGamma`, `dynamicRangeAdjustment` parameters are not related to stretch type. Pass them in to preserve the existing renderer settings if desired. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-stretch.html#createRenderer Read more...} */ createRenderer(params: stretchCreateRendererParams): Promise; } export const stretch: stretch; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-stretch.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-stretch.html#RasterStretchColorrampResult Read more...} */ export interface RasterStretchColorrampResult { renderer: RasterStretchRenderer; bandId: number; } export interface stretchCreateRendererParams { layer: ImageryLayer | ImageryTileLayer | WCSLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; stretchType?: "none" | "min-max" | "standard-deviation" | "histogram-equalization" | "percent-clip" | "sigmoid"; bandId?: number; colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; variableName?: string; gamma?: number; useGamma?: boolean; dynamicRangeAdjustment?: boolean; estimateStatistics?: boolean; signal?: AbortSignal | nullish; } /** * This object contains helper methods for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html UniqueValueRenderer} for raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-uniqueValue.html Read more...} */ interface uniqueValue { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html UniqueValueRenderer} to render thematic imagery. * * @param params Input parameters for generating a unique value visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-uniqueValue.html#createRenderer Read more...} */ createRenderer(params: uniqueValueCreateRendererParams): Promise; } export const uniqueValue: uniqueValue; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-uniqueValue.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-uniqueValue.html#RasterUniqueValuesResult Read more...} */ export interface RasterUniqueValuesResult { renderer: UniqueValueRenderer; classFieldName?: string | nullish; } export interface uniqueValueCreateRendererParams { layer: ImageryLayer | ImageryTileLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; classFieldName?: string; colors?: ([number, number, number, number] | [number, number, number])[]; colorRamp?: AlgorithmicColorRamp | MultipartColorRamp; signal?: AbortSignal | nullish; } /** * This object contains helper methods for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html VectorFieldRenderer} for a * `Vector-UV` or `Vector-MagDir` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-vectorField.html Read more...} */ interface vectorField { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-VectorFieldRenderer.html VectorFieldRenderer} to display raster data with vector symbols. * * @param params Input parameters for generating a vector field visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-vectorField.html#createRenderer Read more...} */ createRenderer(params: vectorFieldCreateRendererParams): Promise; } export const vectorField: vectorField; export interface vectorFieldCreateRendererParams { layer: ImageryLayer | ImageryTileLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; flowRepresentation?: "flow-from" | "flow-to"; rotationType?: "geographic" | "arithmetic"; 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"; signal?: AbortSignal | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-vectorField.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-vectorField.html#VectorFieldRendererResult Read more...} */ export interface VectorFieldRendererResult { renderer: VectorFieldRenderer; } /** * This module provides convenience methods for querying color ramps (arrays of colors) used for raster renderers * in the `module:geoscene/smartMapping/raster/color/renderers` modules. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html Read more...} */ interface colorRamps { /** * Returns all color ramps designed for raster renderers, each as an array of colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#all Read more...} */ all(): colorRampsColorRamp[]; /** * Returns the color ramp matching the given name. * * @param name The name of the desired color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#byName Read more...} */ byName(name: string): colorRampsColorRamp | nullish; /** * Creates a raster color ramp from a list of colors. * * @param options Options for creating a raster color ramp with the following properties: * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#createColorRamp Read more...} */ createColorRamp(options: colorRampsCreateColorRampOptions): MultipartColorRamp | AlgorithmicColorRamp | nullish; /** * Returns a raster color ramp's name. * * @param colorRamp The raster color ramp from which to get the name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#getColorRampName Read more...} */ getColorRampName(colorRamp: MultipartColorRamp | AlgorithmicColorRamp): ColorRampName | nullish; /** * Returns the names of all raster color ramps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#names Read more...} */ names(): string[]; } export const colorRamps: colorRamps; /** * Defines a ramp of colors to use for visualizing raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#ColorRamp Read more...} */ export interface colorRampsColorRamp { name: string; colors: Color[]; } /** * The name of a color ramp and whether it is inverted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-colorRamps.html#ColorRampName Read more...} */ export interface ColorRampName { name: string; inverted: boolean; } export interface colorRampsCreateColorRampOptions { colors: Color[]; algorithm?: "cie-lab" | "lab-lch" | "hsv"; } /** * This object contains utility methods for obtaining information about supported renderers of raster layers (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html Read more...} */ interface supportUtils { /** * Returns default band ids used by a multispectral imagery layer when using a raster {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-rgb.html rgb} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-renderers-stretch.html stretch} renderer. * * @param params Input parameters for getting default band ids about a raster layer. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html#getDefaultBandCombination Read more...} */ getDefaultBandCombination(params: utilsGetDefaultBandCombinationParams): Promise<[number, number, number] | [number] | nullish>; /** * Returns supported raster renderer information of an imagery layer. * * @param params Input parameters for getting supported renderer info about a raster layer. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html#getSupportedRendererInfo Read more...} */ getSupportedRendererInfo(params: utilsGetSupportedRendererInfoParams): Promise; } export const supportUtils: supportUtils; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html#getSupportedRendererInfo getSupportedRendererInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html#SupportedRendererInfo Read more...} */ export interface SupportedRendererInfo { defaultRenderer: | ClassBreaksRenderer | RasterColormapRenderer | UniqueValueRenderer | RasterStretchRenderer | VectorFieldRenderer | RasterShadedReliefRenderer | FlowRenderer; supportedTypes: SupportedRendererType[]; } /** * Supported renderer types for imagery layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-raster-support-utils.html#SupportedRendererType Read more...} */ 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: ImageryLayer | ImageryTileLayer | WCSLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; signal?: AbortSignal | nullish; } export interface utilsGetSupportedRendererInfoParams { layer: ImageryLayer | ImageryTileLayer | WCSLayer; renderingRule?: RasterFunction; rasterFunction?: RasterFunction; signal?: AbortSignal | nullish; } /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html Read more...} */ interface color { /** * Generates a continuous color {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} representing the age of features based * on one or more fields. * * @param params Input parameters for generating a continuous color visualization of age for time data returned from start and/or end date field(s). See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createAgeRenderer Read more...} */ createAgeRenderer(params: colorCreateAgeRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} that may be applied directly to the * layer used to call this method. * * @param params Input parameters for generating a classed color visualization based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer Read more...} */ createClassBreaksRenderer(params: colorCreateClassBreaksRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} that may be applied directly to the * layer used to call this method. * * @param params Input parameters for generating a continuous color visualization based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer Read more...} */ createContinuousRenderer(params: colorCreateContinuousRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudStretchRenderer.html PointCloudStretchRenderer} with a color scheme best-suited * for the view's background based on statistics returned from a given field of a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer}. * * @param params Input parameters for generating a renderer based on the given field of the input layer. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createPCContinuousRenderer Read more...} */ createPCContinuousRenderer(params: colorCreatePCContinuousRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudRGBRenderer.html PointCloudRGBRenderer} based on the `RGB` field of a given * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer}. * * @param params Input parameters for generating a true color visualization based on the `RGB` field of the input layer. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createPCTrueColorRenderer Read more...} */ 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. * * @param params Input parameters for generating a color visual variable based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createVisualVariable Read more...} */ createVisualVariable(params: colorCreateVisualVariableParams): Promise; } export const color: color; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createAgeRenderer createAgeRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#AgeRendererResult Read more...} */ export interface AgeRendererResult { renderer: ClassBreaksRenderer; visualVariable: ColorVariable; unit?: "seconds" | "minutes" | "hours" | "days" | "months" | "years" | nullish; colorScheme: ColorScheme; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#ClassBreaksRendererResult Read more...} */ export interface ClassBreaksRendererResult { renderer: ClassBreaksRenderer; classBreaksResult: ClassBreaksResult; colorScheme: ColorScheme; defaultValuesUsed: boolean; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface colorCreateAgeRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; startTime: Date | string | number; endTime: Date | string | number; unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; maxValue?: number; minValue?: number; theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; filter?: FeatureFilter; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; legendOptions?: colorCreateAgeRendererParamsLegendOptions; statistics?: SummaryStatisticsResult; colorScheme?: ColorScheme; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; defaultSymbolEnabled?: boolean; colorMixMode?: "replace" | "tint" | "multiply" | nullish; signal?: AbortSignal | nullish; } export interface colorCreateAgeRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface colorCreateClassBreaksRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; normalizationType?: "field" | "log" | "percent-of-total"; normalizationTotal?: number; classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; standardDeviationInterval?: 1 | 0.5 | 0.33 | 0.25; numClasses?: number; colorScheme?: ColorScheme; valueExpression?: string; valueExpressionTitle?: string; sqlWhere?: string; filter?: FeatureFilter; outlineOptimizationEnabled?: boolean; legendOptions?: colorCreateClassBreaksRendererParamsLegendOptions; minValue?: number; maxValue?: number; defaultSymbolEnabled?: boolean; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; colorMixMode?: "replace" | "tint" | "multiply" | nullish; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface colorCreateClassBreaksRendererParamsLegendOptions { title?: string; } export interface colorCreateContinuousRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; colorScheme?: ColorScheme; valueExpression?: string; valueExpressionTitle?: string; sqlExpression?: string; sqlWhere?: string; filter?: FeatureFilter; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; legendOptions?: colorCreateContinuousRendererParamsLegendOptions; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; defaultSymbolEnabled?: boolean; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; colorMixMode?: "replace" | "tint" | "multiply" | nullish; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface colorCreateContinuousRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface colorCreatePCContinuousRendererParams { layer: PointCloudLayer; field: string; basemap?: string | Basemap; size?: string; density?: number; colorScheme?: ColorScheme; statistics?: SummaryStatisticsResult; signal?: AbortSignal | nullish; } export interface colorCreatePCTrueColorRendererParams { layer: PointCloudLayer; size?: string; density?: number; signal?: AbortSignal | nullish; } export interface colorCreateVisualVariableParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; theme?: "high-to-low" | "above" | "below" | "above-and-below" | "centered-on" | "extremes"; colorScheme?: ColorScheme; valueExpression?: string; valueExpressionTitle?: string; sqlExpression?: string; sqlWhere?: string; filter?: FeatureFilter; legendOptions?: colorCreateVisualVariableParamsLegendOptions; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; worldScale?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface colorCreateVisualVariableParamsLegendOptions { title?: string; showLegend?: boolean; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer createContinuousRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#ContinuousRendererResult Read more...} */ export interface ContinuousRendererResult { renderer: ClassBreaksRenderer; visualVariable: ColorVariable; colorScheme: ColorScheme; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createPCContinuousRenderer createPCContinuousRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#PCContinuousRendererResult Read more...} */ export interface PCContinuousRendererResult { renderer: PointCloudStretchRenderer; colorScheme: ColorScheme; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createPCTrueColorRenderer createPCTrueColorRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#PCTrueColorRendererResult Read more...} */ export interface PCTrueColorRendererResult { renderer: PointCloudRGBRenderer; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createVisualVariable createVisualVariable()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#VisualVariableResult Read more...} */ export interface VisualVariableResult { visualVariable: ColorVariable; colorScheme: ColorScheme; statistics: SummaryStatisticsResult; defaultValuesUsed: boolean; basemapId?: string | nullish; basemapTheme?: string | nullish; authoringInfo: AuthoringInfo; } /** * This object contains a helper method for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html dot density visualization}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-dotDensity.html Read more...} */ interface dotDensity { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-DotDensityRenderer.html DotDensityRenderer} based on one or more complementary numeric fields * and/or Arcade expressions. * * @param params Input parameters for generating a dot density visualization based on a set of complementary numeric field(s). See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-dotDensity.html#createRenderer Read more...} */ createRenderer(params: dotDensityCreateRendererParams): Promise; } export const dotDensity: dotDensity; export interface dotDensityCreateRendererParams { layer: | FeatureLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView; attributes: dotDensityCreateRendererParamsAttributes[]; dotValueOptimizationEnabled?: boolean; dotBlendingEnabled?: boolean; outlineOptimizationEnabled?: boolean; legendOptions?: dotDensityCreateRendererParamsLegendOptions; dotDensityScheme?: DotDensityScheme; filter?: FeatureFilter; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface dotDensityCreateRendererParamsAttributes { field?: string; label?: string; valueExpression?: string; valueExpressionTitle?: string; } export interface dotDensityCreateRendererParamsLegendOptions { unit?: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-dotDensity.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-dotDensity.html#RendererResult Read more...} */ export interface RendererResult { renderer: DotDensityRenderer; dotDensityScheme: DotDensityScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * This object contains a helper method for generating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} for a point {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html Read more...} */ interface heatmap { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} that may be applied directly to the * layer used to call this method. * * @param params Input parameters for generating a heatmap visualization based on data returned from a given field. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#createRenderer Read more...} */ createRenderer(params: heatmapCreateRendererParams): Promise; /** * Allows you to update the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html#colorStops colorStops} * of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} with opacity, making the low density areas * of the heat map to fade out. * * @param params Input parameters for updating a heatmap renderer with a given fadeRatio. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#updateRenderer Read more...} */ updateRenderer(params: heatmapUpdateRendererParams): HeatmapRenderer; } export const heatmap: heatmap; export interface heatmapCreateRendererParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; field?: string; heatmapScheme?: HeatmapScheme; statistics?: HeatmapStatisticsResult; fadeRatio?: number; fadeToTransparent?: boolean; radius?: number; minRatio?: number; maxRatio?: number; filter?: FeatureFilter; signal?: AbortSignal | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#HeatmapRendererResult Read more...} */ export interface HeatmapRendererResult { renderer: HeatmapRenderer; scheme?: HeatmapScheme | nullish; defaultValuesUsed: boolean; statistics: HeatmapStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface heatmapUpdateRendererParams { renderer: HeatmapRenderer; fadeRatio?: number; } /** * This object contains helper methods for generating location-only visualizations (not data-driven) in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-location.html Read more...} */ interface location { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} that may be applied directly to a * supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params Input parameters for generating a location-based visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-location.html#createRenderer Read more...} */ createRenderer(params: locationCreateRendererParams): Promise; } export const location: location; export interface locationCreateRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; locationScheme?: LocationScheme; sizeOptimizationEnabled?: boolean; outlineOptimizationEnabled?: boolean; filter?: FeatureFilter; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; colorMixMode?: "replace" | "multiply" | "tint" | nullish; forBinning?: boolean; signal?: AbortSignal | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-location.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-location.html#RendererResult Read more...} */ export interface locationRendererResult { renderer: SimpleRenderer; locationScheme: LocationScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html Read more...} */ 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. * * @param params Input parameters for generating an opacity visual variable based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable Read more...} */ createVisualVariable(params: opacityCreateVisualVariableParams): Promise; } export const opacity: opacity; export interface opacityCreateVisualVariableParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; field?: string; normalizationField?: string; valueExpression?: string; valueExpressionTitle?: string; sqlExpression?: string; sqlWhere?: string; filter?: FeatureFilter; legendOptions?: opacityCreateVisualVariableParamsLegendOptions; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; view?: MapView | SceneView; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface opacityCreateVisualVariableParamsLegendOptions { title?: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable createVisualVariable()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#VisualVariableResult Read more...} */ export interface opacityVisualVariableResult { visualVariable: OpacityVariable; statistics: SummaryStatisticsResult; defaultValuesUsed: boolean; authoringInfo: AuthoringInfo; } /** * This object contains a helper method for generating a pie chart for every feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html Read more...} */ interface pieChart { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html PieChartRenderer} based on a set of numeric fields. * * @param params Input parameters for generating a pie chart visualization based on a set of numeric fields. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#createRenderer Read more...} */ createRenderer(params: pieChartCreateRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html PieChartRenderer} to use for a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualization based off an input layer's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-UniqueValueRenderer.html UniqueValueRenderer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer}. * * @param params Input parameters for generating a pie chart visualization for clustering. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#createRendererForClustering Read more...} */ createRendererForClustering(params: pieChartCreateRendererForClusteringParams): Promise; } export const pieChart: pieChart; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#createRendererForClustering createRendererForClustering()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#ClusterRendererResult Read more...} */ export interface ClusterRendererResult { renderer: PieChartRenderer; fields: AggregateField[]; } export interface pieChartCreateRendererForClusteringParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; shape?: "pie" | "donut"; defaultSymbolEnabled?: boolean; legendOptions?: pieChartCreateRendererForClusteringParamsLegendOptions | null; signal?: AbortSignal | nullish; } export interface pieChartCreateRendererForClusteringParamsLegendOptions { title?: string; } export interface pieChartCreateRendererParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer; view: MapView; attributes: pieChartCreateRendererParamsAttributes[]; shape?: "pie" | "donut"; includeSizeVariable?: boolean; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; filter?: FeatureFilter; legendOptions?: pieChartCreateRendererParamsLegendOptions | null; pieChartScheme?: PieChartScheme; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface pieChartCreateRendererParamsAttributes { field?: string; label?: string; valueExpression?: string; valueExpressionTitle?: string; } export interface pieChartCreateRendererParamsLegendOptions { title?: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html#RendererResult Read more...} */ export interface pieChartRendererResult { renderer: PieChartRenderer; size?: sizeVisualVariableResult | nullish; pieChartScheme: PieChartScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; statistics: UniqueValuesResult; } /** * This object contains a helper method for generating a predominance visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html Read more...} */ interface predominance { /** * Generates a predominance renderer based on a set of competing numeric fields. * * @param params Input parameters for generating a predominance visualization based on a set of competing field(s). See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html#createRenderer Read more...} */ createRenderer(params: predominanceCreateRendererParams): Promise; } export const predominance: predominance; export interface predominanceCreateRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; fields: predominanceCreateRendererParamsFields[]; includeOpacityVariable?: boolean; includeSizeVariable?: boolean; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; filter?: FeatureFilter; legendOptions?: predominanceCreateRendererParamsLegendOptions; statistics?: SummaryStatisticsResult; sortBy?: "count" | "value"; predominanceScheme?: PredominanceScheme; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; defaultSymbolEnabled?: boolean; colorMixMode?: "replace" | "tint" | "multiply" | nullish; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface predominanceCreateRendererParamsFields { name: string; label?: string; } export interface predominanceCreateRendererParamsLegendOptions { title?: string; showLegend?: boolean; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html#RendererResult Read more...} */ export interface predominanceRendererResult { renderer: UniqueValueRenderer; predominantCategoryInfos: typeUniqueValueInfo[]; excludedCategoryInfos: any[]; size?: sizeVisualVariableResult | nullish; opacity?: opacityVisualVariableResult | nullish; predominanceScheme: PredominanceScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * This object contains a helper method for creating a renderer for exploring the relationship between two numeric attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html Read more...} */ interface relationship { /** * Generates a relationship renderer (bivariate choropleth) based on a set of competing numeric fields. * * @param params Input parameters for generating a relationship visualization based on a pair of numeric field(s). See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#createRenderer Read more...} */ createRenderer(params: relationshipCreateRendererParams): Promise; /** * Updates a relationship renderer (bivariate choropleth) generated from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#createRenderer createRenderer()} * based on the given input parameters. * * @param params Input parameters for updating a relationship visualization created in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#createRenderer createRenderer()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#updateRenderer Read more...} */ updateRenderer(params: relationshipUpdateRendererParams): Promise; } export const relationship: relationship; export interface relationshipCreateRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; field1: relationshipCreateRendererParamsField1; field2: relationshipCreateRendererParamsField2; classificationMethod?: "quantile" | "equal-interval" | "natural-breaks"; focus?: "HH" | "HL" | "LH" | "LL" | nullish; numClasses?: 2 | 3 | 4 | nullish; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; filter?: FeatureFilter; legendOptions?: relationshipCreateRendererParamsLegendOptions; relationshipScheme?: RelationshipScheme; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; defaultSymbolEnabled?: boolean; colorMixMode?: "tint" | "replace" | "multiply" | nullish; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface relationshipCreateRendererParamsField1 { field: string; normalizationField?: string; maxValue?: number; minValue?: number; label?: string; } export interface relationshipCreateRendererParamsField2 { field: string; normalizationField?: string; maxValue?: number; minValue?: number; label?: string; } export interface relationshipCreateRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface relationshipUpdateRendererParams { field1: relationshipUpdateRendererParamsField1; field2: relationshipUpdateRendererParamsField2; focus?: "HH" | "HL" | "LH" | "LL" | nullish; numClasses?: 2 | 3 | 4 | nullish; colors: Color[]; renderer: UniqueValueRenderer; } export interface relationshipUpdateRendererParamsField1 { field: string; normalizationField?: string; classBreakInfos: ClassBreak[]; label?: string; } export interface relationshipUpdateRendererParamsField2 { field: string; normalizationField?: string; classBreakInfos: ClassBreak[]; label?: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html#RendererResult Read more...} */ export interface relationshipRendererResult { renderer: UniqueValueRenderer; classBreaks: RendererResultClassBreaks; uniqueValueInfos: typeUniqueValueInfo[]; relationshipScheme: RelationshipScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface RendererResultClassBreaks { field1: ClassBreaksResult; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html Read more...} */ interface size { /** * Generates a continuous size {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} representing the age of features based * on one or more fields. * * @param params Input parameters for generating a continuous size visualization of age for time data returned from start and/or end date field(s). See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createAgeRenderer Read more...} */ createAgeRenderer(params: sizeCreateAgeRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} that may be applied directly to the * layer used to call this method. * * @param params Input parameters for generating a classed size visualization based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer Read more...} */ createClassBreaksRenderer(params: sizeCreateClassBreaksRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} that may be applied directly to the * layer used to call this method. * * @param params Input parameters for generating size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer Read more...} */ 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. * * @param params Input parameters for generating size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createVisualVariables Read more...} */ createVisualVariables(params: sizeCreateVisualVariablesParams): Promise; /** * Updates a renderer generated from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer()} that uses a specialty reference size variable (i.e. * * @param params Input parameters for updating an existing reference size visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#updateRendererWithReferenceSize Read more...} */ updateRendererWithReferenceSize(params: sizeUpdateRendererWithReferenceSizeParams): Promise; /** * Updates a renderer that uses a specialty spike variable (i.e. * * @param params Input parameters for updating an existing spike visualization. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#updateRendererWithSpike Read more...} */ updateRendererWithSpike(params: sizeUpdateRendererWithSpikeParams): Promise; } export const size: size; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createAgeRenderer createAgeRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#AgeRendererResult Read more...} */ export interface sizeAgeRendererResult { renderer: ClassBreaksRenderer; visualVariables: SizeVariable[]; unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds" | nullish; sizeScheme?: SizeScheme | nullish; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#ClassBreaksRendererResult Read more...} */ export interface sizeClassBreaksRendererResult { renderer: ClassBreaksRenderer; classBreaksResult?: ClassBreaksResult | nullish; sizeScheme?: SizeScheme | nullish; defaultValuesUsed: boolean; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#ContinuousRendererResult Read more...} */ export interface sizeContinuousRendererResult { renderer: ClassBreaksRenderer; visualVariables: SizeVariable[]; sizeScheme?: SizeScheme | nullish; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; isGrid?: boolean; } export interface sizeCreateAgeRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; startTime: Date | string | number; endTime: Date | string | number; unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; theme?: "high-to-low" | "above" | "below"; filter?: FeatureFilter; maxValue?: number; minValue?: number; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; legendOptions?: sizeCreateAgeRendererParamsLegendOptions; statistics?: SummaryStatisticsResult; sizeScheme?: SizeScheme; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; defaultSymbolEnabled?: boolean; signal?: AbortSignal | nullish; } export interface sizeCreateAgeRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface sizeCreateClassBreaksRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; normalizationType?: "field" | "log" | "percent-of-total"; normalizationTotal?: number; classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; standardDeviationInterval?: 1 | 0.5 | 0.33 | 0.25 | nullish; numClasses?: number; sizeScheme?: SizeScheme; valueExpression?: string; valueExpressionTitle?: string; sqlWhere?: string; filter?: FeatureFilter; outlineOptimizationEnabled?: boolean; legendOptions?: sizeCreateClassBreaksRendererParamsLegendOptions; minValue?: number; maxValue?: number; defaultSymbolEnabled?: boolean; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface sizeCreateClassBreaksRendererParamsLegendOptions { title?: string; } export interface sizeCreateContinuousRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; sizeScheme?: SizeScheme; valueExpression?: string; valueExpressionTitle?: string; theme?: "high-to-low" | "above" | "below" | "reference-size" | "spike"; referenceSizeOptions?: sizeCreateContinuousRendererParamsReferenceSizeOptions; filter?: FeatureFilter; spikeOptions?: sizeCreateContinuousRendererParamsSpikeOptions; sqlExpression?: string; sqlWhere?: string; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; legendOptions?: sizeCreateContinuousRendererParamsLegendOptions; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; defaultSymbolEnabled?: boolean; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface sizeCreateContinuousRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface sizeCreateContinuousRendererParamsReferenceSizeOptions { symbolStyle: "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square"; } export interface sizeCreateContinuousRendererParamsSpikeOptions { symbolStyle?: | "triangle-solid-fill-open-outline" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-closed" | "triangle-gradient-fill-open-outline" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-closed" | "triangle-open-outline" | "triangle-closed-outline"; minHeight?: number; maxHeight?: number; baseWidth?: number; strokeWidth?: number; defaultHeight?: number; } export interface sizeCreateVisualVariablesParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field: string; normalizationField?: string; sizeScheme?: SizeScheme; valueExpression?: string; valueExpressionTitle?: string; theme?: "high-to-low" | "above" | "below" | "reference-size" | "spike"; referenceSizeOptions?: sizeCreateVisualVariablesParamsReferenceSizeOptions; filter?: FeatureFilter; sqlExpression?: string; sqlWhere?: string; sizeOptimizationEnabled?: boolean; legendOptions?: sizeCreateVisualVariablesParamsLegendOptions; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; worldScale?: boolean; axis?: "all" | "height"; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface sizeCreateVisualVariablesParamsLegendOptions { title?: string; showLegend?: boolean; } export interface sizeCreateVisualVariablesParamsReferenceSizeOptions { symbolStyle: "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square"; } export interface sizeUpdateRendererWithReferenceSizeParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; renderer?: ClassBreaksRenderer | UniqueValueRenderer; view: MapView | SceneView; field?: string; normalizationField?: string; sizeStops: SizeStop[]; referenceSizeOptions?: sizeUpdateRendererWithReferenceSizeParamsReferenceSizeOptions; sizeScheme?: SizeScheme; typeScheme?: TypeScheme; sizeOptimizationEnabled?: boolean; forBinning?: boolean; } export interface sizeUpdateRendererWithReferenceSizeParamsReferenceSizeOptions { symbolStyle: "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square"; } export interface sizeUpdateRendererWithSpikeParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; renderer?: ClassBreaksRenderer | UniqueValueRenderer; field?: string; normalizationField?: string; sizeStops: SizeStop[]; spikeOptions?: sizeUpdateRendererWithSpikeParamsSpikeOptions; sizeScheme?: SizeScheme; typeScheme?: TypeScheme; forBinning?: boolean; } export interface sizeUpdateRendererWithSpikeParamsSpikeOptions { symbolStyle?: | "triangle-solid-fill-open-outline" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-closed" | "triangle-gradient-fill-open-outline" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-closed" | "triangle-open-outline" | "triangle-closed-outline"; baseWidth?: number; strokeWidth?: number; defaultHeight?: number; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createVisualVariables createVisualVariables()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#VisualVariableResult Read more...} */ export interface sizeVisualVariableResult { visualVariables: SizeVariable[]; sizeScheme?: SizeScheme | nullish; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; authoringInfo: AuthoringInfo; isGrid?: boolean; } /** * This module provides a function for regenerating renderers based on the current state of the layer and view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-support-rendererUtils.html Read more...} */ interface rendererUtils { /** * Regenerates the renderer for a layer based on the current state of the layer and view. * * @param params An object containing the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-support-rendererUtils.html#regenerateRenderer Read more...} */ regenerateRenderer(params: rendererUtilsRegenerateRendererParams): Promise; } export const rendererUtils: rendererUtils; export interface rendererUtilsRegenerateRendererParams { layer: FeatureLayer; view: MapView; renderer?: RendererUnion; forBinning?: boolean; filter?: FeatureFilter; signal?: AbortSignal; includedParts?: ("color-variable" | "size-variable" | "class-breaks")[]; } /** * This module provides utility functions for creating and updating spike symbols for size renderers * generated with a `spike` theme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-support-spikeUtils.html Read more...} */ interface spikeUtils { /** * Creates a spike symbol for use in size renderers generated with a `spike` theme. * * @param symbolInfo An object containing properties of the symbol to create. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-support-spikeUtils.html#createSpikeSymbol Read more...} */ createSpikeSymbol(symbolInfo: spikeUtilsCreateSpikeSymbolSymbolInfo): CIMSymbol; /** * Updates the properties of a spike symbol. * * @param symbol The spike symbol to update. * @param symbolInfo An object containing properties of the symbol to update. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-support-spikeUtils.html#updateSpikeSymbol Read more...} */ updateSpikeSymbol(symbol: CIMSymbol, symbolInfo: spikeUtilsUpdateSpikeSymbolSymbolInfo): CIMSymbol; } export const spikeUtils: spikeUtils; export interface spikeUtilsCreateSpikeSymbolSymbolInfo { color: Color; strokeColor?: Color; baseWidth?: number; strokeWidth?: number; defaultHeight?: number; primitiveOverrides?: PrimitiveOverride[]; symbolStyle?: | "triangle-solid-fill-open-outline" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-closed" | "triangle-gradient-fill-open-outline" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-closed" | "triangle-open-outline" | "triangle-closed-outline"; } export interface spikeUtilsUpdateSpikeSymbolSymbolInfo { color: Color; strokeColor?: Color; baseWidth?: number; strokeWidth?: number; defaultHeight?: number; primitiveOverrides?: PrimitiveOverride[]; symbolStyle?: | "triangle-solid-fill-open-outline" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-closed" | "triangle-gradient-fill-open-outline" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-closed" | "triangle-open-outline" | "triangle-closed-outline"; } /** * This object contains helper methods for generating data-driven visualizations with unique types (or categories) * based on a field value from features in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html Read more...} */ interface type { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PointCloudUniqueValueRenderer.html PointCloudUniqueValueRenderer} based on * a given field of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer}. * * @param params Input parameters for generating a renderer based on the given field of the input layer. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#createPCClassRenderer Read more...} */ createPCClassRenderer(params: typeCreatePCClassRendererParams): Promise; /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} that may be applied directly to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} that supports renderers. * * @param params Input parameters for generating symbols to represent unique types based on data returned from a given field. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#createRenderer Read more...} */ createRenderer(params: typeCreateRendererParams): Promise; } export const type: type; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#createPCClassRenderer createPCClassRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#PCClassRendererResult Read more...} */ export interface PCClassRendererResult { renderer: PointCloudUniqueValueRenderer; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#RendererResult Read more...} */ export interface typeRendererResult { renderer: UniqueValueRenderer; uniqueValueInfos: typeUniqueValueInfo[]; excludedUniqueValueInfos: any[]; typeScheme: TypeScheme; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface typeCreatePCClassRendererParams { layer: PointCloudLayer; field: string; size?: string; density?: number; typeScheme?: TypeScheme; statistics?: UniqueValuesResult; signal?: AbortSignal | nullish; } export interface typeCreateRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; field2?: string; field3?: string; numTypes?: number; sortBy?: "count" | "value" | "none"; typeScheme?: TypeScheme; valueExpression?: string; valueExpressionTitle?: string; outlineOptimizationEnabled?: boolean; sizeOptimizationEnabled?: boolean; filter?: FeatureFilter; legendOptions?: typeCreateRendererParamsLegendOptions; defaultSymbolEnabled?: boolean; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; statistics?: UniqueValuesResult; colorMixMode?: "tint" | "replace" | "multiply" | nullish; returnAllCodedValues?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface typeCreateRendererParamsLegendOptions { title: string; } /** * Describes the symbol, label, and value of a unique value generated by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#createRenderer createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-type.html#UniqueValueInfo Read more...} */ export interface typeUniqueValueInfo { value: string | number; count: number; label: string; symbol: SymbolUnion; } /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html Read more...} */ interface univariateColorSize { /** * Generates a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} that may be applied directly to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer Read more...} */ createContinuousRenderer(params: univariateColorSizeCreateContinuousRendererParams): Promise; /** * This method generates color and size visual variables, both based on the same given field or expression. * * @param params Input parameters for generating color and size visual variables based on data returned from a given field or expression. See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createVisualVariables Read more...} */ createVisualVariables(params: univariateColorSizeCreateVisualVariablesParams): Promise; } export const univariateColorSize: univariateColorSize; /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult Read more...} */ export interface univariateColorSizeContinuousRendererResult { renderer: ClassBreaksRenderer; color?: ContinuousRendererResultColor | nullish; size: ContinuousRendererResultSize; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface univariateColorSizeCreateContinuousRendererParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; valueExpression?: string; valueExpressionTitle?: string; theme?: "high-to-low" | "above" | "below" | "above-and-below"; sqlExpression?: string; sqlWhere?: string; filter?: FeatureFilter; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; defaultSymbolEnabled?: boolean; colorOptions?: univariateColorSizeCreateContinuousRendererParamsColorOptions; sizeOptions?: univariateColorSizeCreateContinuousRendererParamsSizeOptions; symbolOptions?: univariateColorSizeCreateContinuousRendererParamsSymbolOptions; legendOptions?: univariateColorSizeCreateContinuousRendererParamsLegendOptions; symbolType?: "2d" | "3d-flat" | "3d-volumetric" | "3d-volumetric-uniform"; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface univariateColorSizeCreateContinuousRendererParamsColorOptions { colorScheme?: ColorScheme; isContinuous?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsLegendOptions { title?: string; showLegend?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsSizeOptions { sizeScheme?: SizeScheme; sizeOptimizationEnabled?: boolean; } export interface univariateColorSizeCreateContinuousRendererParamsSymbolOptions { symbolStyle?: | "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb"; symbols?: univariateColorSizeCreateContinuousRendererParamsSymbolOptionsSymbols; } export interface univariateColorSizeCreateContinuousRendererParamsSymbolOptionsSymbols { above: SymbolUnion; below: SymbolUnion; } export interface univariateColorSizeCreateVisualVariablesParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view?: MapView | SceneView; field?: string; normalizationField?: string; valueExpression?: string; valueExpressionTitle?: string; theme?: "high-to-low" | "above" | "below" | "above-and-below"; sqlExpression?: string; sqlWhere?: string; filter?: FeatureFilter; statistics?: SummaryStatisticsResult; minValue?: number; maxValue?: number; colorOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptions; sizeOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptions; worldScale?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface univariateColorSizeCreateVisualVariablesParamsColorOptions { theme?: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; colorScheme?: ColorScheme; legendOptions?: univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions; isContinuous?: boolean; } export interface univariateColorSizeCreateVisualVariablesParamsColorOptionsLegendOptions { title: string; } export interface univariateColorSizeCreateVisualVariablesParamsSizeOptions { axis?: "all" | "height"; sizeScheme?: SizeScheme; legendOptions?: univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions; } export interface univariateColorSizeCreateVisualVariablesParamsSizeOptionsLegendOptions { title: string; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createVisualVariables createVisualVariables()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#VisualVariablesResult Read more...} */ export interface VisualVariablesResult { color?: VisualVariablesResultColor | nullish; size: VisualVariablesResultSize; defaultValuesUsed: boolean; statistics: SummaryStatisticsResult; basemapId?: string | nullish; basemapTheme?: string | nullish; authoringInfo: AuthoringInfo; } export interface ContinuousRendererResultColor { visualVariable: ColorVariable; colorScheme: ColorScheme; } export interface ContinuousRendererResultSize { visualVariables: SizeVariable[]; sizeScheme?: SizeScheme | nullish; } export interface VisualVariablesResultColor { visualVariable: ColorVariable; colorScheme: ColorScheme; } export interface VisualVariablesResultSize { visualVariables: SizeVariable[]; sizeScheme?: SizeScheme | nullish; } /** * Function for generating class breaks for an input field in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} based * on a given classification method and normalization type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html Read more...} */ interface statisticsClassBreaks { /** * Generates class breaks for an input field (or expression) of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} based * on a given classification method and normalization type. * * @param params See the table below for details about parameters that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html#classBreaks Read more...} */ classBreaks(params: classBreaksClassBreaksParams): Promise; } const __statisticsClassBreaksMapped: statisticsClassBreaks; export const statisticsClassBreaks: typeof __statisticsClassBreaksMapped.classBreaks; /** * An object describing a single class break generated from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html#classBreaks classBreaks()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html#ClassBreak Read more...} */ export interface ClassBreak { label?: string | nullish; minValue: number; maxValue: number; } export interface classBreaksClassBreaksParams { layer: | FeatureLayer | SceneLayer | CSVLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; field?: string; normalizationField?: string; classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; standardDeviationInterval?: number; minValue?: number; maxValue?: number; numClasses?: number; valueExpression?: string; sqlWhere?: string; view?: MapView | SceneView; filter?: FeatureFilter; features?: Graphic[]; useFeaturesInView?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } /** * Object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html#classBreaks classBreaks()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-classBreaks.html#ClassBreaksResult Read more...} */ export interface ClassBreaksResult { classBreakInfos: ClassBreak[]; minValue?: number | nullish; maxValue?: number | nullish; normalizationTotal?: number | nullish; } /** * Function for generating statistics from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} for * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-heatmapStatistics.html Read more...} */ interface heatmapStatistics { /** * Returns an object containing various statistics describing the intensity values * for a heatmap visualization of a given point {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics Read more...} */ heatmapStatistics(params: heatmapStatisticsHeatmapStatisticsParams): Promise; } const __heatmapStatisticsMapped: heatmapStatistics; export const heatmapStatistics: typeof __heatmapStatisticsMapped.heatmapStatistics; export interface heatmapStatisticsHeatmapStatisticsParams { layer: | FeatureLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; view: MapView | SceneView; field?: string; radius?: number; signal?: AbortSignal | nullish; } /** * The statistics returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics heatmapStatistics()} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-heatmapStatistics.html#HeatmapStatisticsResult Read more...} */ export interface HeatmapStatisticsResult { max: number | nullish; min: number | nullish; } /** * Generates a histogram based on data in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} for a given field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html Read more...} */ interface histogram { /** * Generates a histogram for data returned from a `field` in a given `layer`. * * @param params See the table below for details on parameters that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram Read more...} */ histogram(params: histogramHistogramParams): Promise; } const __histogramMapped: histogram; export const histogram: typeof __histogramMapped.histogram; export interface histogramHistogramParams { layer: | FeatureLayer | SceneLayer | CSVLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | CatalogLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer | ImageryLayer; field?: string; normalizationType?: "field" | "log" | "percent-of-total" | "natural-log" | "square-root"; normalizationField?: string; normalizationTotal?: number; classificationMethod?: "equal-interval" | "natural-breaks" | "quantile" | "standard-deviation"; standardDeviationInterval?: number; minValue?: number; maxValue?: number; numBins?: number; valueExpression?: string; sqlExpression?: string; sqlWhere?: string; view?: MapView | SceneView; filter?: FeatureFilter; features?: Graphic[]; useFeaturesInView?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } /** * Function for generating category statistics for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html predominance} * renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-predominantCategories.html Read more...} */ 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. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-predominantCategories.html#predominantCategories Read more...} */ predominantCategories(params: predominantCategoriesPredominantCategoriesParams): Promise; } const __predominantCategoriesMapped: predominantCategories; export const predominantCategories: typeof __predominantCategoriesMapped.predominantCategories; export interface predominantCategoriesPredominantCategoriesParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; fields: string[]; forBinning?: boolean; view?: MapView | SceneView; signal?: AbortSignal | nullish; } /** * The statistics returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-predominantCategories.html#predominantCategories predominantCategories()} function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-predominantCategories.html#PredominantCategoriesResult Read more...} */ export interface PredominantCategoriesResult { predominantCategoryInfos: PredominantCategoriesResultPredominantCategoryInfos[]; } export interface PredominantCategoriesResultPredominantCategoryInfos { value: string | number | nullish; count: number; label?: string | nullish; } /** * Function for generating attribute statistics in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} based on * values returned from a given field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatistics.html Read more...} */ interface summaryStatistics { /** * Returns an object containing statistics describing a set of values returned * from a field (or expression) in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatistics.html#summaryStatistics Read more...} */ summaryStatistics(params: summaryStatisticsSummaryStatisticsParams): Promise; } const __summaryStatisticsMapped: summaryStatistics; export const summaryStatistics: typeof __summaryStatisticsMapped.summaryStatistics; /** * The type of statistic to include or exclude in the summary statistics calculation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatistics.html#OutStatisticType Read more...} */ export type OutStatisticType = | "avg" | "count" | "max" | "median" | "min" | "stddev" | "sum" | "variance" | "nullcount"; /** * The statistics returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatistics.html#summaryStatistics summaryStatistics()} query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult Read more...} */ export interface SummaryStatisticsResult { avg?: number | nullish; count?: number | nullish; max?: number | nullish; median?: number | string | nullish; min?: number | nullish; stddev?: number | nullish; sum?: number | nullish; variance?: number | nullish; nullcount?: number | nullish; } export interface summaryStatisticsSummaryStatisticsParams { layer: | FeatureLayer | SceneLayer | CSVLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | CatalogLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer | ImageryLayer; field?: string; valueExpression?: string; sqlExpression?: string; sqlWhere?: string; normalizationType?: "field" | "log" | "percent-of-total" | "natural-log" | "square-root"; normalizationField?: string; normalizationTotal?: number; minValue?: number; maxValue?: number; view?: MapView | SceneView; outStatisticTypes?: summaryStatisticsSummaryStatisticsParamsOutStatisticTypes; filter?: FeatureFilter; features?: Graphic[]; useFeaturesInView?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface summaryStatisticsSummaryStatisticsParamsOutStatisticTypes { include?: OutStatisticType[]; exclude?: OutStatisticType[]; } /** * Function for generating statistics for the age of features in a layer based on a given start time and end time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatisticsForAge.html Read more...} */ interface summaryStatisticsForAge { /** * Returns an object containing various statistics describing an age value (e.g. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-summaryStatisticsForAge.html#summaryStatisticsForAge Read more...} */ summaryStatisticsForAge(params: summaryStatisticsForAgeSummaryStatisticsForAgeParams): Promise; } const __summaryStatisticsForAgeMapped: summaryStatisticsForAge; export const summaryStatisticsForAge: typeof __summaryStatisticsForAgeMapped.summaryStatisticsForAge; export interface summaryStatisticsForAgeSummaryStatisticsForAgeParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | ParquetLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; startTime: Date | string | number; endTime: Date | string | number; unit: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; view?: MapView | SceneView; outStatisticTypes?: summaryStatisticsForAgeSummaryStatisticsForAgeParamsOutStatisticTypes; filter?: FeatureFilter; signal?: AbortSignal | nullish; } export interface summaryStatisticsForAgeSummaryStatisticsForAgeParamsOutStatisticTypes { include?: OutStatisticType[]; exclude?: OutStatisticType[]; } /** * Provides utility functions for generating {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions * intended for use in an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createAgeRenderer age renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-ageUtils.html Read more...} */ interface ageUtils { /** * Returns an {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expression for visualizing the age of a feature based * on a given start time and end time. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-ageUtils.html#getAgeExpressions Read more...} */ getAgeExpressions(params: ageUtilsGetAgeExpressionsParams): AgeExpressionsResult; } export const ageUtils: ageUtils; /** * The result object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-ageUtils.html#getAgeExpressions getAgeExpressions()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-ageUtils.html#AgeExpressionsResult Read more...} */ export interface AgeExpressionsResult { valueExpression: string; statisticsQuery: any; histogramQuery: any; } export interface ageUtilsGetAgeExpressionsParams { layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer; startTime: Date | string | number; endTime: Date | string | number; unit?: "years" | "months" | "days" | "hours" | "minutes" | "seconds"; } /** * Provides utility functions for generating {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} and SQL expressions * intended for use in an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html predominance renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html Read more...} */ interface predominanceUtils { /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} and SQL expressions used for visualizing the predominant category (or field) among a set of competing fields. * * @param layer The layer from which to generate the Arcade and SQL expressions for querying predominance statistics. * @param fieldNames An array of numeric field names for which to create the Arcade and SQL expressions used to build the predominance renderer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#getPredominanceExpressions Read more...} */ getPredominanceExpressions(layer: | FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer, 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#OpacityExpressionInfo Read more...} */ export interface OpacityExpressionInfo { valueExpression: string; statisticsQuery: SQLExpressionInfo; histogramQuery: SQLExpressionInfo; } /** * The result object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#getAgeExpressions getAgeExpressions()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#PredominantExpressions Read more...} */ export interface PredominantExpressions { predominantCategory: PredominantExpressionsPredominantCategory; size: SizeExpressionInfo; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#SizeExpressionInfo Read more...} */ export interface SizeExpressionInfo { valueExpression: string; statisticsQuery: SQLExpressionInfo; histogramQuery: SQLExpressionInfo; } /** * SQL expressions used to query feature services for predominant values and related statistics given a set of fields. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-support-predominanceUtils.html#SQLExpressionInfo Read more...} */ export interface SQLExpressionInfo { sqlExpression: string; sqlWhere: string; } export interface PredominantExpressionsPredominantCategory { valueExpression: string; } /** * A module for importing types used in smart mapping statistics modules. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html Read more...} */ namespace types { /** * Represents the bin of a histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#HistogramBin Read more...} */ export interface HistogramBin { count: number; minValue: number; maxValue: number; } /** * The result returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#histogram histogram()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#HistogramResult Read more...} */ export interface HistogramResult { bins: HistogramBin[]; minValue?: number | nullish; maxValue?: number | nullish; normalizationTotal?: number | nullish; } } /** * Represents the bin of a histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#HistogramBin Read more...} */ export interface HistogramBin { count: number; minValue: number; maxValue: number; } /** * The result returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#histogram histogram()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-types.html#HistogramResult Read more...} */ export interface HistogramResult { bins: HistogramBin[]; minValue?: number | nullish; maxValue?: number | nullish; normalizationTotal?: number | nullish; } /** * A function that queries for unique values from a field in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-uniqueValues.html Read more...} */ interface uniqueValues { /** * Returns an object containing an array of unique values queried from a given field * (or values returned from an expression) in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} along with the total count of features that * belong to the given category. * * @param params See the table below for details of each parameter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-uniqueValues.html#uniqueValues Read more...} */ uniqueValues(params: uniqueValuesUniqueValuesParams): Promise; } const __uniqueValuesMapped: uniqueValues; export const uniqueValues: typeof __uniqueValuesMapped.uniqueValues; /** * An object that contains the unique values returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-uniqueValues.html#uniqueValues uniqueValues()} query * of a layer's field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-uniqueValues.html#UniqueValuesResult Read more...} */ export interface UniqueValuesResult { uniqueValueInfos: UniqueValuesResultUniqueValueInfos[]; } export interface uniqueValuesUniqueValuesParams { layer: | FeatureLayer | SceneLayer | CSVLayer | ParquetLayer | PointCloudLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | CatalogFootprintLayer | CatalogLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | SubtypeSublayer | ImageryLayer; field?: string; valueExpression?: string; sqlExpression?: string; sqlWhere?: string; returnAllCodedValues?: boolean; view?: MapView | SceneView; filter?: FeatureFilter; features?: Graphic[]; useFeaturesInView?: boolean; forBinning?: boolean; signal?: AbortSignal | nullish; } export interface UniqueValuesResultUniqueValueInfos { value: string | number | nullish; count: number; } /** * Object containing helper methods for generating optimal symbols for * data-driven color visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html Read more...} */ interface symbologyColor { /** * Clones a color scheme object. * * @param scheme The color scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#cloneScheme Read more...} */ cloneScheme(scheme: ColorScheme | nullish): ColorScheme | nullish; /** * Flips the colors in reverse order of the input color scheme. * * @param scheme The color scheme to reverse. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#flipColors Read more...} */ flipColors(scheme: ColorScheme): ColorScheme; /** * Returns all schemes matching the given color ramp. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getMatchingSchemes Read more...} */ getMatchingSchemes(params: colorGetMatchingSchemesParams): ColorScheme[]; /** * Returns a color scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getSchemeByName Read more...} */ getSchemeByName(params: colorGetSchemeByNameParams): ColorScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for * data-driven color visualizations in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getSchemes Read more...} */ getSchemes(params: colorGetSchemesParams): ColorSchemes | nullish; /** * Returns an array of color schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getSchemesByTag Read more...} */ getSchemesByTag(params: colorGetSchemesByTagParams): ColorScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyColor: symbologyColor; export interface colorGetMatchingSchemesParams { theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; colors: Color[]; geometryType: string; worldScale?: boolean; view?: SceneView; } export interface colorGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; view?: SceneView; worldScale?: boolean; } export interface colorGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; view?: SceneView; worldScale?: boolean; } export interface colorGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme: "high-to-low" | "above-and-below" | "centered-on" | "extremes"; view?: SceneView; worldScale?: boolean; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorScheme Read more...} */ export type ColorScheme = ColorSchemeForPoint | ColorSchemeForPolyline | ColorSchemeForPolygon | ColorSchemeForMesh; /** * Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorSchemeForMesh Read more...} */ export interface ColorSchemeForMesh { name: string; tags: string[]; id: string; theme: string; colors: Color[]; noDataColor: Color; colorsForClassBreaks: ColorSchemeForMeshColorsForClassBreaks[]; opacity: number; } /** * Properties defining the symbology scheme used to visualize point features with attribute data-driven color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorSchemeForPoint Read more...} */ export interface ColorSchemeForPoint { name: string; tags: string[]; id: string; theme: string; colors: Color[]; noDataColor: Color; colorsForClassBreaks: ColorSchemeForPointColorsForClassBreaks[]; outline: ColorSchemeForPointOutline; size: number; opacity: number; } /** * Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorSchemeForPolygon Read more...} */ export interface ColorSchemeForPolygon { name: string; tags: string[]; id: string; theme: string; colors: Color[]; noDataColor: Color; colorsForClassBreaks: ColorSchemeForPolygonColorsForClassBreaks[]; outline: ColorSchemeForPolygonOutline; opacity: number; } /** * Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorSchemeForPolyline Read more...} */ export interface ColorSchemeForPolyline { name: string; tags: string[]; id: string; theme: string; colors: Color[]; noDataColor: Color; colorsForClassBreaks: ColorSchemeForPolylineColorsForClassBreaks[]; width: number; opacity: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#ColorSchemes Read more...} */ export interface ColorSchemes { primaryScheme: ColorScheme; secondarySchemes: ColorScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * Describes a theme that pairs well with the given basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html#Theme Read more...} */ export interface colorTheme { name: string; label: string; description: string; basemaps: string[]; } export interface ColorSchemeForMeshColorsForClassBreaks { colors: Color[]; numClasses: number; } export interface ColorSchemeForPointColorsForClassBreaks { colors: Color[]; numClasses: number; } export interface ColorSchemeForPointOutline { color: Color; width: number; } export interface ColorSchemeForPolygonColorsForClassBreaks { colors: Color[]; numClasses: number; } export interface ColorSchemeForPolygonOutline { color: Color; width: number; } export interface ColorSchemeForPolylineColorsForClassBreaks { colors: Color[]; numClasses: number; } /** * Object containing helper methods for getting optimal symbol schemes used * to create {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-dotDensity.html dot density visualizations}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html Read more...} */ interface symbologyDotDensity { /** * Clones a dot density scheme object. * * @param scheme The dot density scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#cloneScheme Read more...} */ cloneScheme(scheme: DotDensityScheme | nullish): DotDensityScheme | nullish; /** * Returns a dot density scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#getSchemeByName Read more...} */ getSchemeByName(params: dotDensityGetSchemeByNameParams): DotDensityScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for dot density-based * data-driven visualizations in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#getSchemes Read more...} */ getSchemes(params: dotDensityGetSchemesParams): DotDensitySchemes | nullish; /** * Returns an array of dot density schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#getSchemesByTag Read more...} */ getSchemesByTag(params: dotDensityGetSchemesByTagParams): DotDensityScheme[]; } export const symbologyDotDensity: symbologyDotDensity; export interface dotDensityGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; numColors: number; } export interface dotDensityGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; numColors: number; } export interface dotDensityGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; numColors: number; } /** * Properties defining the symbology scheme used to visualize predominance for polygon features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#DotDensityScheme Read more...} */ export interface DotDensityScheme { name: string; tags: string[]; colors: Color[]; outline: DotDensitySchemeOutline; opacity: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-dotDensity.html#DotDensitySchemes Read more...} */ export interface DotDensitySchemes { primaryScheme: DotDensityScheme; secondarySchemes: DotDensityScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface DotDensitySchemeOutline { color: Color; width: number | string; } /** * Object containing helper methods for generating optimal settings for * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-FlowRenderer.html FlowRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html Read more...} */ interface symbologyFlow { /** * Clones a flow scheme object. * * @param scheme The flow scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#cloneScheme Read more...} */ cloneScheme(scheme: FlowScheme | nullish): FlowScheme | nullish; /** * Returns the flow scheme with the given name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#getSchemeByName Read more...} */ getSchemeByName(params: flowGetSchemeByNameParams): FlowScheme | nullish; /** * Returns a primary scheme and secondary schemes defining properties for * flow visualizations in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#getSchemes Read more...} */ getSchemes(params: flowGetSchemesParams): FlowSchemes | nullish; /** * Returns the flow schemes filtered by tags included and excluded from the paramters. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#getSchemesByTag Read more...} */ getSchemesByTag(params: flowGetSchemesByTagParams): FlowScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or basemap object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): flowTheme[]; } export const symbologyFlow: symbologyFlow; export interface flowGetSchemeByNameParams { name: string; theme?: "flow-line" | "wave-front"; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; } export interface flowGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; theme?: "flow-line" | "wave-front"; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; } export interface flowGetSchemesParams { theme?: "flow-line" | "wave-front"; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; } /** * Suggested property values for defining the scheme used to visualize flow lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#FlowScheme Read more...} */ export interface FlowScheme { name: string; tags: string[]; id: string; theme: "flow-line" | "wave-front"; color: Color; colors: Color[]; density: number; flowSpeed: number; trailLength: number; trailWidth: number; trailCap: "round" | "butt"; layerEffect: string; minSize: number; maxSize: number; minOpacity: number; maxOpacity: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#FlowSchemes Read more...} */ export interface FlowSchemes { primaryScheme: FlowScheme; secondarySchemes: FlowScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * Describes a theme that pairs well with the given basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-flow.html#Theme Read more...} */ export interface flowTheme { name: string; label: string; description: string; basemaps: string[]; } /** * Object containing helper methods for generating optimal colors for * heatmap visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html Read more...} */ interface symbologyHeatmap { /** * Clones a heatmap scheme object. * * @param scheme The heatmap scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#cloneScheme Read more...} */ cloneScheme(scheme: HeatmapScheme | nullish): HeatmapScheme | nullish; /** * Returns a heatmap scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#getSchemeByName Read more...} */ getSchemeByName(params: heatmapGetSchemeByNameParams): HeatmapScheme | nullish; /** * Returns a primary scheme and secondary schemes defining properties for * heatmap visualizations in * a point {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#getSchemes Read more...} */ getSchemes(params: heatmapGetSchemesParams): HeatmapSchemes | nullish; /** * Returns an array of heatmap schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#getSchemesByTag Read more...} */ getSchemesByTag(params: heatmapGetSchemesByTagParams): HeatmapScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyHeatmap: symbologyHeatmap; export interface heatmapGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; } export interface heatmapGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap: string | Basemap; } export interface heatmapGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; } /** * Properties defining the symbology scheme used to visualize point features as a heatmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#HeatmapScheme Read more...} */ export interface HeatmapScheme { name: string; tags: string[]; id: string; colors: Color[]; opacity: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-heatmap.html#HeatmapSchemes Read more...} */ export interface HeatmapSchemes { primaryScheme: HeatmapScheme; secondarySchemes: HeatmapScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } /** * Object containing helper methods for generating optimal symbols for * location-only visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html Read more...} */ interface symbologyLocation { /** * Clones a location scheme object. * * @param scheme The location scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#cloneScheme Read more...} */ cloneScheme(scheme: LocationScheme | nullish): LocationScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for * location-only visualizions in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#getSchemes Read more...} */ getSchemes(params: locationGetSchemesParams): LocationSchemes | nullish; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyLocation: symbologyLocation; export interface locationGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; view?: SceneView; worldScale?: boolean; } /** * Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationScheme Read more...} */ export type LocationScheme = | LocationSchemeForPoint | LocationSchemeForPolyline | LocationSchemeForPolygon | LocationSchemeForMesh; /** * Properties defining the location-only symbology scheme used to visualize mesh features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationSchemeForMesh Read more...} */ export interface LocationSchemeForMesh { color: Color; opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize point features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationSchemeForPoint Read more...} */ export interface LocationSchemeForPoint { color: Color; outline: LocationSchemeForPointOutline; size: number; opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize polygon features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationSchemeForPolygon Read more...} */ export interface LocationSchemeForPolygon { color: Color; outline: LocationSchemeForPolygonOutline; opacity: number; } /** * Properties defining the location-only symbology scheme used to visualize polyline features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationSchemeForPolyline Read more...} */ export interface LocationSchemeForPolyline { color: Color; width: number; opacity: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-location.html#LocationSchemes Read more...} */ export interface LocationSchemes { primaryScheme: LocationScheme; secondarySchemes: LocationScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface LocationSchemeForPointOutline { color: Color; width: number; } export interface LocationSchemeForPolygonOutline { color: Color; width: number; } /** * Object containing helper methods for getting optimal color schemes used * to create {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-pieChart.html pie chart visualizations}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html Read more...} */ interface symbologyPieChart { /** * Clones a pie chart scheme object. * * @param scheme The pie chart scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#cloneScheme Read more...} */ cloneScheme(scheme: PieChartScheme | nullish): PieChartScheme | nullish; /** * Returns a pie chart scheme with the given name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#getSchemeByName Read more...} */ getSchemeByName(params: pieChartGetSchemeByNameParams): PieChartScheme | nullish; /** * Returns a primary scheme and secondary schemes defining properties for pie chart visualizations. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#getSchemes Read more...} */ getSchemes(params: pieChartGetSchemesParams): PieChartSchemes | nullish; /** * Returns an array of pie chart schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#getSchemesByTag Read more...} */ getSchemesByTag(params: pieChartGetSchemesByTagParams): PieChartScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyPieChart: symbologyPieChart; export interface pieChartGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "polygon"; numColors: number; } export interface pieChartGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "polygon"; numColors: number; } export interface pieChartGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "polygon"; numColors: number; } /** * Properties defining the colors and schemes used to visualize pie charts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#PieChartScheme Read more...} */ export interface PieChartScheme { name: string; tags: string[]; colors: Color[]; colorForOthersCategory: Color; outline: PieChartSchemeOutline; sizeScheme?: SizeScheme | nullish; size: number | string; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-pieChart.html#PieChartSchemes Read more...} */ export interface PieChartSchemes { primaryScheme: PieChartScheme; secondarySchemes: PieChartScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface PieChartSchemeOutline { color: Color; width: number | string; } /** * Object containing helper methods for getting optimal symbol schemes used * to create {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-predominance.html predominance visualizations}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html Read more...} */ interface symbologyPredominance { /** * Clones a predominance scheme object. * * @param scheme The predominance scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#cloneScheme Read more...} */ cloneScheme(scheme: PredominanceScheme | nullish): PredominanceScheme | nullish; /** * Returns a predominance scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#getSchemeByName Read more...} */ getSchemeByName(params: predominanceGetSchemeByNameParams): PredominanceScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for predominance-based * data-driven visualizations in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#getSchemes Read more...} */ getSchemes(params: predominanceGetSchemesParams): PredominanceSchemes | nullish; /** * Returns an array of predominance schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#getSchemesByTag Read more...} */ getSchemesByTag(params: predominanceGetSchemesByTagParams): PredominanceScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyPredominance: symbologyPredominance; export interface predominanceGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; numColors: number; theme?: "default"; worldScale?: boolean; view?: SceneView; } export interface predominanceGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; numColors: number; theme?: "default"; worldScale?: boolean; view?: SceneView; } export interface predominanceGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; numColors: number; theme?: "default"; worldScale?: boolean; view?: SceneView; } /** * Defines the symbology scheme used to visualize predominance based on the layer's geometry type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceScheme Read more...} */ export type PredominanceScheme = | PredominanceSchemeForPoint | PredominanceSchemeForPolyline | PredominanceSchemeForPolygon | PredominanceSchemeForMesh; /** * Properties defining the symbology scheme used to visualize predominance for mesh features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceSchemeForMesh Read more...} */ export interface PredominanceSchemeForMesh { name: string; tags: string[]; colors: Color[]; noDataColor: Color; opacity: number; } /** * Properties defining the symbology scheme used to visualize predominance for point features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceSchemeForPoint Read more...} */ export interface PredominanceSchemeForPoint { name: string; tags: string[]; colors: Color[]; noDataColor: Color; outline: PredominanceSchemeForPointOutline; opacity: number; sizeScheme: SizeSchemeForPoint; } /** * Properties defining the symbology scheme used to visualize predominance for polygon features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceSchemeForPolygon Read more...} */ export interface PredominanceSchemeForPolygon { name: string; tags: string[]; colors: Color[]; noDataColor: Color; outline: PredominanceSchemeForPolygonOutline; opacity: number; sizeScheme: SizeSchemeForPolygon; } /** * Properties defining the symbology scheme used to visualize predominance for polyline features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceSchemeForPolyline Read more...} */ export interface PredominanceSchemeForPolyline { name: string; tags: string[]; colors: Color[]; noDataColor: Color; width: number; opacity: number; sizeScheme: SizeSchemeForPolyline; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-predominance.html#PredominanceSchemes Read more...} */ export interface PredominanceSchemes { primaryScheme: PredominanceScheme; secondarySchemes: PredominanceScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface PredominanceSchemeForPointOutline { color: Color; width: number; } export interface PredominanceSchemeForPolygonOutline { color: Color; width: number; } /** * Object containing helper methods for getting optimal symbol schemes used * to create {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship (bivariate choropleth) visualizations}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html Read more...} */ interface symbologyRelationship { /** * Clones a relationship (bivariate color) scheme object. * * @param scheme The relationship scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#cloneScheme Read more...} */ cloneScheme(scheme: RelationshipScheme | nullish): RelationshipScheme | nullish; /** * Returns a relationship scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#getSchemeByName Read more...} */ getSchemeByName(params: relationshipGetSchemeByNameParams): RelationshipScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for relationship-based (bivariate choropleth) * data-driven visualizations in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#getSchemes Read more...} */ getSchemes(params: relationshipGetSchemesParams): RelationshipSchemes | nullish; /** * Returns an array of relationship schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#getSchemesByTag Read more...} */ getSchemesByTag(params: relationshipGetSchemesByTagParams): RelationshipScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyRelationship: symbologyRelationship; export interface relationshipGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "default"; worldScale?: boolean; view?: SceneView; } export interface relationshipGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "default"; worldScale?: boolean; view?: SceneView; } export interface relationshipGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "default"; worldScale?: boolean; view?: SceneView; } /** * Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipScheme Read more...} */ export type RelationshipScheme = | RelationshipSchemeForPoint | RelationshipSchemeForPolyline | RelationshipSchemeForPolygon | RelationshipSchemeForMesh; /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipSchemeForMesh Read more...} */ export interface RelationshipSchemeForMesh { name: string; tags: string[]; id: string; colorsForClassBreaks: RelationshipSchemeForMeshColorsForClassBreaks[]; noDataColor: Color; opacity: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipSchemeForPoint Read more...} */ export interface RelationshipSchemeForPoint { name: string; tags: string[]; id: string; colorsForClassBreaks: RelationshipSchemeForPointColorsForClassBreaks[]; noDataColor: Color; outline: RelationshipSchemeForPointOutline; opacity: number; size: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipSchemeForPolygon Read more...} */ export interface RelationshipSchemeForPolygon { name: string; tags: string[]; id: string; colorsForClassBreaks: RelationshipSchemeForPolygonColorsForClassBreaks[]; noDataColor: Color; outline: RelationshipSchemeForPolygonOutline; opacity: number; } /** * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipSchemeForPolyline Read more...} */ export interface RelationshipSchemeForPolyline { name: string; tags: string[]; id: string; colorsForClassBreaks: RelationshipSchemeForPolylineColorsForClassBreaks[]; noDataColor: Color; opacity: number; width: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-relationship.html#RelationshipSchemes Read more...} */ export interface RelationshipSchemes { primaryScheme: RelationshipScheme; secondarySchemes: RelationshipScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface RelationshipSchemeForMeshColorsForClassBreaks { colors: Color[][]; numClasses: number; } export interface RelationshipSchemeForPointColorsForClassBreaks { colors: Color[][]; numClasses: number; } export interface RelationshipSchemeForPointOutline { color: Color; width: number; } export interface RelationshipSchemeForPolygonColorsForClassBreaks { colors: Color[][]; numClasses: number; } export interface RelationshipSchemeForPolygonOutline { color: Color; width: number; } export interface RelationshipSchemeForPolylineColorsForClassBreaks { colors: Color[][]; numClasses: number; } /** * Object containing helper methods for generating optimal symbols for data-driven size visualizations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html Read more...} */ interface symbologySize { /** * Clones a size scheme object. * * @param scheme The SizeScheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#cloneScheme Read more...} */ cloneScheme(scheme: SizeScheme | nullish): SizeScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for size-based * data-driven visualizations in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#getSchemes Read more...} */ getSchemes(params: sizeGetSchemesParams): SizeSchemes | nullish; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologySize: symbologySize; export interface sizeGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon"; view?: SceneView; worldScale?: boolean; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#SizeScheme Read more...} */ export type SizeScheme = SizeSchemeForPoint | SizeSchemeForPolyline | SizeSchemeForPolygon; /** * Properties defining the symbology scheme used to visualize point features driven by attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#SizeSchemeForPoint Read more...} */ export interface SizeSchemeForPoint { color: Color; noDataColor: Color; outline: SizeSchemeForPointOutline; size: number | string; noDataSize: number | string; minSize: number | string; maxSize: number | string; opacity?: number; } /** * Properties defining the symbology scheme used to visualize polygon features driven by attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#SizeSchemeForPolygon Read more...} */ export interface SizeSchemeForPolygon { marker: SizeSchemeForPoint; background: SizeSchemeForPolygonBackground; opacity?: number; } /** * Properties defining the symbology scheme used to visualize polyline features driven by attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#SizeSchemeForPolyline Read more...} */ export interface SizeSchemeForPolyline { color: Color; noDataColor: Color; width: number | string; noDataWidth: number | string; minWidth: number | string; maxWidth: number | string; opacity?: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-size.html#SizeSchemes Read more...} */ export interface SizeSchemes { primaryScheme: SizeScheme; secondarySchemes: SizeScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface SizeSchemeForPointOutline { color: Color; width: number | string; } export interface SizeSchemeForPolygonBackground { color: Color; outline: SizeSchemeForPolygonBackgroundOutline; } export interface SizeSchemeForPolygonBackgroundOutline { color: Color; width: number | string; } /** * This module provides convenience methods for querying color ramps (arrays of colors) used in the smart mapping * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html color symbology} module. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html Read more...} */ interface supportColorRamps { /** * Returns all color ramps available in smartMapping {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html color schemes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html#all Read more...} */ all(): supportColorRampsColorRamp[]; /** * Returns the color ramp available in the smartMapping {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html color schemes} * matching the given name. * * @param name The name of the desired color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html#byName Read more...} */ byName(name: string): supportColorRampsColorRamp | nullish; /** * Returns the color ramps available in the smartMapping {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html color schemes} * matching the given tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html#byTag Read more...} */ byTag(params: colorRampsByTagParams): supportColorRampsColorRamp[]; /** * Returns the names of all color ramps available in the smartMapping {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-color.html color schemes}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html#names Read more...} */ names(): string[]; } export const supportColorRamps: supportColorRamps; /** * Defines a ramp of colors to use for visualizing data in a chart, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-support-colorRamps.html#ColorRamp Read more...} */ export interface supportColorRampsColorRamp { name: string; tags: string[]; colors: Color[]; colorsForClassBreaks: ColorRampColorsForClassBreaks[]; } export interface colorRampsByTagParams { includedTags?: string[]; excludedTags?: string[]; } export interface ColorRampColorsForClassBreaks { colors: Color[]; numClasses: number; } /** * Object containing helper methods for getting optimal symbol themes used * to create data-driven visualizations of unique values or types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html Read more...} */ interface symbologyType { /** * Clones a type scheme object. * * @param scheme The type scheme object to clone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#cloneScheme Read more...} */ cloneScheme(scheme: TypeScheme | nullish): TypeScheme | nullish; /** * Returns a type scheme with the provided name. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#getSchemeByName Read more...} */ getSchemeByName(params: typeGetSchemeByNameParams): TypeScheme | nullish; /** * Returns a primary scheme and secondary schemes defining symbol properties for type-based * data-driven visualizations in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#getSchemes Read more...} */ getSchemes(params: typeGetSchemesParams): TypeSchemes | nullish; /** * Returns an array of type schemes with the provided tags. * * @param params See the table below for details of each parameter that may be passed to this function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#getSchemesByTag Read more...} */ getSchemesByTag(params: typeGetSchemesByTagParams): TypeScheme[]; /** * Returns metadata for the available themes. * * @param basemap The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap GeoScene basemap string} or object that will be used with the returned theme(s). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#getThemes Read more...} */ getThemes(basemap?: string | Basemap): colorTheme[]; } export const symbologyType: symbologyType; /** * Properties defining the symbology scheme used to visualize point clouds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#PointCloudClassScheme Read more...} */ export interface PointCloudClassScheme { name: string; tags: string[]; colors: Color[]; theme: string; } export interface typeGetSchemeByNameParams { name: string; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "point-cloud-class" | "default"; numColors?: number; worldScale?: boolean; view?: SceneView; } export interface typeGetSchemesByTagParams { includedTags?: string[]; excludedTags?: string[]; basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "point-cloud-class" | "default"; numColors?: number; worldScale?: boolean; view?: SceneView; } export interface typeGetSchemesParams { basemap?: string | Basemap; basemapTheme?: "light" | "dark"; geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch"; theme?: "point-cloud-class" | "default"; numColors?: number; worldScale?: boolean; view?: SceneView; } /** * Properties defining the symbology scheme used to visualize features with attribute data-driven types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeScheme Read more...} */ export type TypeScheme = | TypeSchemeForPoint | TypeSchemeForPolyline | TypeSchemeForPolygon | TypeSchemeForMesh | PointCloudClassScheme; /** * Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeSchemeForMesh Read more...} */ export interface TypeSchemeForMesh { name: string; tags: string[]; colors: Color[]; noDataColor: Color; opacity: number; theme: string; } /** * Properties defining the symbology scheme used to visualize point features driven by type-based attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeSchemeForPoint Read more...} */ export interface TypeSchemeForPoint { name: string; tags: string[]; colors: Color[]; noDataColor: Color; outline: TypeSchemeForPointOutline; size: number; opacity: number; theme: string; } /** * Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeSchemeForPolygon Read more...} */ export interface TypeSchemeForPolygon { name: string; tags: string[]; colors: Color[]; noDataColor: Color; outline: TypeSchemeForPolygonOutline; opacity: number; theme: string; } /** * Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeSchemeForPolyline Read more...} */ export interface TypeSchemeForPolyline { name: string; tags: string[]; colors: Color[]; noDataColor: Color; width: number; opacity: number; theme: string; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#getSchemes getSchemes()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-symbology-type.html#TypeSchemes Read more...} */ export interface TypeSchemes { primaryScheme: TypeScheme; secondarySchemes: TypeScheme[]; basemapId?: string | nullish; basemapTheme?: string | nullish; } export interface TypeSchemeForPointOutline { color: Color; width: number; } export interface TypeSchemeForPolygonOutline { color: Color; width: number; } export interface ActionBase extends Accessor, Identifiable { } export class ActionBase { /** * Set this property to `true` to display a spinner icon. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#active Read more...} */ active: boolean; /** * This adds a CSS class to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html ActionButton's} * node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#className Read more...} */ className: string | nullish; /** * Indicates whether this action is disabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#disabled Read more...} */ disabled: boolean; /** * Calcite icon used for the action. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#icon Read more...} */ icon: string | nullish; /** * The name of the ID assigned to this action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#id Read more...} */ id: string | nullish; /** * The title of the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#title Read more...} */ title: string | nullish; /** * Specifies the type of action. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#type Read more...} */ type: "button" | "slider" | "toggle" | nullish; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates if the action is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#visible Read more...} */ visible: boolean; /** * Actions are customizable behavior which can be executed in certain widgets such as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popups}, * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html BasemapLayerList}, or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html Read more...} */ constructor(properties?: ActionBaseProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#clone Read more...} */ clone(): ActionBase; } interface ActionBaseProperties extends IdentifiableProperties { /** * Set this property to `true` to display a spinner icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#active Read more...} */ active?: boolean; /** * This adds a CSS class to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html ActionButton's} * node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#className Read more...} */ className?: string | nullish; /** * Indicates whether this action is disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#disabled Read more...} */ disabled?: boolean; /** * Calcite icon used for the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#icon Read more...} */ icon?: string | nullish; /** * The name of the ID assigned to this action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#id Read more...} */ id?: string | nullish; /** * The title of the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#title Read more...} */ title?: string | nullish; /** * Specifies the type of action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#type Read more...} */ type?: "button" | "slider" | "toggle" | nullish; /** * Indicates if the action is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionBase.html#visible Read more...} */ visible?: boolean; } export class ActionButton extends ActionBase { /** * The URL to an image that will be used to represent the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html#image Read more...} */ image: string | nullish; /** * Specifies the type of action. * * @default "button" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html#type Read more...} */ readonly type: "button"; /** * A customizable button that performs a specific action(s) used * in widgets such as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList}, and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html BasemapLayerList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html Read more...} */ constructor(properties?: ActionButtonProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html#clone Read more...} */ clone(): ActionButton; } interface ActionButtonProperties extends ActionBaseProperties { /** * The URL to an image that will be used to represent the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html#image Read more...} */ image?: string | nullish; } export class ActionToggle extends ActionBase { /** * Specifies the type of action. * * @default "toggle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html#type Read more...} */ readonly type: "toggle"; /** * Indicates the value of whether the action is toggled on/off. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html#value Read more...} */ value: boolean; /** * A customizable toggle used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget * that performs a specific action(s) which can be toggled * on/off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html Read more...} */ constructor(properties?: ActionToggleProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html#clone Read more...} */ clone(): ActionToggle; } interface ActionToggleProperties extends ActionBaseProperties { /** * Indicates the value of whether the action is toggled on/off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html#value Read more...} */ value?: boolean; } export class BasemapStyle extends Accessor { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#apiKey Read more...} */ apiKey: string | nullish; /** * The id of the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#id Read more...} */ id: string | nullish; /** * The language of the place labels in the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#language Read more...} */ language: string | nullish; /** * Indicates whether to display {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html places} with the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#places Read more...} */ places: "all" | "attributed" | "none" | nullish; /** * The [URL](https://doc.geoscene.cn/rest/basemap-styles/#service-url) to the basemap styles service. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#serviceUrl Read more...} */ serviceUrl: string; /** * Displays country boundaries and labels based on a specific view of a country. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#worldview Read more...} */ worldview: string | nullish; /** * The style of the basemap from the [basemap styles service (v2)](https://doc.geoscene.cn/rest/basemap-styles/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html Read more...} */ constructor(properties?: BasemapStyleProperties); } interface BasemapStyleProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#apiKey Read more...} */ apiKey?: string | nullish; /** * The id of the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#id Read more...} */ id?: string | nullish; /** * The language of the place labels in the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#language Read more...} */ language?: string | nullish; /** * Indicates whether to display {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-places.html places} with the basemap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#places Read more...} */ places?: "all" | "attributed" | "none" | nullish; /** * The [URL](https://doc.geoscene.cn/rest/basemap-styles/#service-url) to the basemap styles service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#serviceUrl Read more...} */ serviceUrl?: string; /** * Displays country boundaries and labels based on a specific view of a country. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-BasemapStyle.html#worldview Read more...} */ worldview?: string | nullish; } export class LayersMixin { get layers(): Collection; set layers(value: CollectionProperties | Layer[]); /** * Adds a layer to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. * * @param layer Layer or a promise that resolves to a layer to add to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#add Read more...} */ add(layer: Layer | Promise, index?: number): void; /** * Adds a layer or an array of layers to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. * * @param layers Layer(s) to be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. * @param index A layer can be added at a specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection}. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#layers layers collection} and the index is normalized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#addMany Read more...} */ addMany(layers: Layer[], index?: number): void; /** * Returns a layer based on the given layer ID. * * @param layerId The ID assigned to the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#findLayerById Read more...} */ findLayerById(layerId: string): Layer | nullish; /** * Removes the specified layer from the layers collection. * * @param layer Layer to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#remove Read more...} */ remove(layer: Layer): Layer | nullish; /** * Removes all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#removeAll Read more...} */ removeAll(): Layer[]; /** * Removes the specified layers. * * @param layers Array of layers to remove from the layers collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#removeMany Read more...} */ removeMany(layers: Layer[]): Layer[]; /** * Changes the layer order. * * @param layer The layer to be moved. * @param index The index location for placing the layer. The bottom-most layer has an index of `0`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-LayersMixin.html#reorder Read more...} */ reorder(layer: Layer, index: number): Layer | nullish; } interface LayersMixinProperties { layers?: CollectionProperties | Layer[]; } export interface MapFloorInfo extends Accessor, JSONSupport { } export class MapFloorInfo { /** * Floor-aware maps facilitate visualizing, editing, and analyzing indoor data and they allow for fast navigation of buildings in maps and scenes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html Read more...} */ constructor(properties?: MapFloorInfoProperties); /** * Contains the facility features of a floor plan, which describe the footprints of managed buildings and other structures. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#facilityLayer Read more...} */ get facilityLayer(): FacilityLayerInfo | nullish; set facilityLayer(value: FacilityLayerInfoProperties | nullish); /** * Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#levelLayer Read more...} */ get levelLayer(): LevelLayerInfo | nullish; set levelLayer(value: LevelLayerInfoProperties | nullish); /** * Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#siteLayer Read more...} */ get siteLayer(): SiteLayerInfo | nullish; set siteLayer(value: SiteLayerInfoProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#facilityLayer Read more...} */ facilityLayer?: FacilityLayerInfoProperties | nullish; /** * Contains the level features of a floor plan, which describe the footprint of each occupiable floor contained in a managed facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#levelLayer Read more...} */ levelLayer?: LevelLayerInfoProperties | nullish; /** * Contains the site features of a floor plan, which describe the boundaries of managed sites and is used for visualization in mapmaking. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-MapFloorInfo.html#siteLayer Read more...} */ siteLayer?: SiteLayerInfoProperties | nullish; } /** * Various utils for working with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} widget functionality. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html Read more...} */ interface popupUtils { /** * Creates an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html fieldInfo} used for populating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html FieldsContent}. * * @param config A configuration object containing properties for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-FieldInfo.html fieldInfo}. * @param options Options for creating the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#createFieldInfos Read more...} */ createFieldInfos(config: FieldInfosConfig, options?: CreatePopupTemplateOptions): FieldInfo[]; /** * Creates {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html fields} content used for populating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * @param config A configuration object containing properties for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html FieldsContent}. * @param options Options for creating the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#createFieldsContent Read more...} */ createFieldsContent(config: FieldInfosConfig, options?: CreatePopupTemplateOptions): FieldsContent; /** * Creates a popup template given the specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#Config config} information. * * @param config A configuration object containing properties for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * @param options Options for creating the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#createPopupTemplate Read more...} */ createPopupTemplate(config: Config, options?: CreatePopupTemplateOptions): PopupTemplate | nullish; /** * Creates a default popup template to use for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionBinning.html FeatureReductionBinning} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html FeatureReductionCluster} visualizations. * * @param params Parameters for creating a feature reduction popup template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#createPopupTemplateForFeatureReduction Read more...} */ createPopupTemplateForFeatureReduction(params: popupUtilsCreatePopupTemplateForFeatureReductionParams): PopupTemplate | nullish; } export const popupUtils: popupUtils; /** * A configuration object containing properties for creating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#Config Read more...} */ export interface Config { displayField?: string; title: string; editFieldsInfo?: EditFieldsInfo; fields: Field[]; objectIdField?: string; } /** * Options for creating the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#CreatePopupTemplateOptions Read more...} */ export interface CreatePopupTemplateOptions { ignoreFieldTypes?: | ( | "small-integer" | "integer" | "big-integer" | "single" | "double" | "long" | "string" | "date" | "date-only" | "time-only" | "timestamp-offset" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" )[] | nullish; visibleFieldNames?: Set; } /** * A configuration object containing field properties for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-FieldsContent.html FieldsContent} for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-popupUtils.html#FieldInfosConfig Read more...} */ export interface FieldInfosConfig { editFieldsInfo?: EditFieldsInfo; fields: Field[]; objectIdField?: string; } export interface popupUtilsCreatePopupTemplateForFeatureReductionParams { featureReduction: FeatureReductionBinning | FeatureReductionCluster; fields?: Field[]; title?: string; } export class TablesMixin { get tables(): Collection; set tables(value: CollectionProperties | Layer[]); /** * Returns a table based on the given table ID. * * @param tableId The ID assigned to the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-TablesMixin.html#findTableById Read more...} */ findTableById(tableId: string): Layer | nullish; } interface TablesMixinProperties { tables?: CollectionProperties | Layer[]; } /** * Provides utility methods for working with [dates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-timeUtils.html Read more...} */ interface timeUtils { /** * Returns the time extent of all layers which are "feature based" time-aware and/or have a "layer based" time-aware with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#visibilityTimeExtent Layer.visibilityTimeExtent} set. * * @param layers An array or collection of layers to compute a time extent from. * @param signal [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) allows for cancelable requests. If canceled, the promise will be rejected with an error named `AbortError`. See also [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-timeUtils.html#getTimeExtentFromLayers Read more...} */ getTimeExtentFromLayers(layers: Layer[] | Collection, signal?: AbortSignal | nullish): Promise; /** * Extracts time slider settings from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene} if the document contains a time slider widget definition. * * @param document An instance of a webmap or webscene to extract time slider settings from. * @param signal Signal object that can be used to abort the asynchronous task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-timeUtils.html#getTimeSliderSettingsFromWebDocument Read more...} */ getTimeSliderSettingsFromWebDocument(document: WebMap | WebScene, signal?: AbortSignal | nullish): Promise; } export const timeUtils: timeUtils; /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Symbol} classes when developing with * {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes} to import union types, or individual modules to import classes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html Read more...} */ namespace symbols { /** * CIMSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/CIMSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#CIMSymbol Read more...} */ export type CIMSymbol = __geoscene.CIMSymbol; export const CIMSymbol: typeof __geoscene.CIMSymbol; /** * ExtrudeSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/ExtrudeSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#ExtrudeSymbol3DLayer Read more...} */ export type ExtrudeSymbol3DLayer = __geoscene.ExtrudeSymbol3DLayer; export const ExtrudeSymbol3DLayer: typeof __geoscene.ExtrudeSymbol3DLayer; /** * FillSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/FillSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#FillSymbol3DLayer Read more...} */ export type FillSymbol3DLayer = __geoscene.FillSymbol3DLayer; export const FillSymbol3DLayer: typeof __geoscene.FillSymbol3DLayer; /** * WaterSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/WaterSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#WaterSymbol3DLayer Read more...} */ export type WaterSymbol3DLayer = __geoscene.WaterSymbol3DLayer; export const WaterSymbol3DLayer: typeof __geoscene.WaterSymbol3DLayer; /** * Font. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/Font} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Font Read more...} */ export type Font = __geoscene.Font; export const Font: typeof __geoscene.Font; /** * IconSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/IconSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#IconSymbol3DLayer Read more...} */ export type IconSymbol3DLayer = __geoscene.IconSymbol3DLayer; export const IconSymbol3DLayer: typeof __geoscene.IconSymbol3DLayer; /** * LabelSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LabelSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LabelSymbol3D Read more...} */ export type LabelSymbol3D = __geoscene.LabelSymbol3D; export const LabelSymbol3D: typeof __geoscene.LabelSymbol3D; /** * LineSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LineSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LineSymbol3D Read more...} */ export type LineSymbol3D = __geoscene.LineSymbol3D; export const LineSymbol3D: typeof __geoscene.LineSymbol3D; /** * LineSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LineSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LineSymbol3DLayer Read more...} */ export type LineSymbol3DLayer = __geoscene.LineSymbol3DLayer; export const LineSymbol3DLayer: typeof __geoscene.LineSymbol3DLayer; /** * MeshSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/MeshSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#MeshSymbol3D Read more...} */ export type MeshSymbol3D = __geoscene.MeshSymbol3D; export const MeshSymbol3D: typeof __geoscene.MeshSymbol3D; /** * ObjectSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/ObjectSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#ObjectSymbol3DLayer Read more...} */ export type ObjectSymbol3DLayer = __geoscene.ObjectSymbol3DLayer; export const ObjectSymbol3DLayer: typeof __geoscene.ObjectSymbol3DLayer; /** * PathSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PathSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PathSymbol3DLayer Read more...} */ export type PathSymbol3DLayer = __geoscene.PathSymbol3DLayer; export const PathSymbol3DLayer: typeof __geoscene.PathSymbol3DLayer; /** * PictureFillSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PictureFillSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PictureFillSymbol Read more...} */ export type PictureFillSymbol = __geoscene.PictureFillSymbol; export const PictureFillSymbol: typeof __geoscene.PictureFillSymbol; /** * PictureMarkerSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PictureMarkerSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PictureMarkerSymbol Read more...} */ export type PictureMarkerSymbol = __geoscene.PictureMarkerSymbol; export const PictureMarkerSymbol: typeof __geoscene.PictureMarkerSymbol; /** * PointSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PointSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PointSymbol3D Read more...} */ export type PointSymbol3D = __geoscene.PointSymbol3D; export const PointSymbol3D: typeof __geoscene.PointSymbol3D; /** * PolygonSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PolygonSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PolygonSymbol3D Read more...} */ export type PolygonSymbol3D = __geoscene.PolygonSymbol3D; export const PolygonSymbol3D: typeof __geoscene.PolygonSymbol3D; /** * SimpleFillSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleFillSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleFillSymbol Read more...} */ export type SimpleFillSymbol = __geoscene.SimpleFillSymbol; export const SimpleFillSymbol: typeof __geoscene.SimpleFillSymbol; /** * SimpleLineSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleLineSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleLineSymbol Read more...} */ export type SimpleLineSymbol = __geoscene.SimpleLineSymbol; export const SimpleLineSymbol: typeof __geoscene.SimpleLineSymbol; /** * SimpleMarkerSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleMarkerSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleMarkerSymbol Read more...} */ export type SimpleMarkerSymbol = __geoscene.SimpleMarkerSymbol; export const SimpleMarkerSymbol: typeof __geoscene.SimpleMarkerSymbol; /** * TextSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/TextSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#TextSymbol Read more...} */ export type TextSymbol = __geoscene.TextSymbol; export const TextSymbol: typeof __geoscene.TextSymbol; /** * TextSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/TextSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#TextSymbol3DLayer Read more...} */ export type TextSymbol3DLayer = __geoscene.TextSymbol3DLayer; export const TextSymbol3DLayer: typeof __geoscene.TextSymbol3DLayer; /** * WebStyleSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/WebStyleSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#WebStyleSymbol Read more...} */ export type WebStyleSymbol = __geoscene.WebStyleSymbol; export const WebStyleSymbol: typeof __geoscene.WebStyleSymbol; /** * FillSymbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~FillSymbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#FillSymbol Read more...} */ export type FillSymbol = __geoscene.PictureFillSymbol | __geoscene.SimpleFillSymbol; /** * MarkerSymbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~MarkerSymbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#MarkerSymbol Read more...} */ export type MarkerSymbol = __geoscene.PictureMarkerSymbol | __geoscene.SimpleMarkerSymbol; /** * Symbol2D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol2D Read more...} */ export type Symbol2D = | __geoscene.PictureFillSymbol | __geoscene.PictureMarkerSymbol | __geoscene.SimpleFillSymbol | __geoscene.SimpleLineSymbol | __geoscene.SimpleMarkerSymbol | __geoscene.TextSymbol | __geoscene.CIMSymbol; /** * Symbol3DLayer types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol3DLayerUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol3DLayer Read more...} */ export type Symbol3DLayer = | __geoscene.ExtrudeSymbol3DLayer | __geoscene.FillSymbol3DLayer | __geoscene.WaterSymbol3DLayer | __geoscene.IconSymbol3DLayer | __geoscene.LineSymbol3DLayer | __geoscene.ObjectSymbol3DLayer | __geoscene.PathSymbol3DLayer | __geoscene.TextSymbol3DLayer; /** * Symbol3D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol3DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol3D Read more...} */ export type Symbol3D = | __geoscene.LabelSymbol3D | __geoscene.LineSymbol3D | __geoscene.MeshSymbol3D | __geoscene.PointSymbol3D | __geoscene.PolygonSymbol3D; /** * Symbol2D3D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol2D3DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol2D3D Read more...} */ export type Symbol2D3D = __geoscene.Symbol2D | __geoscene.symbolsSymbol3D; /** * Symbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~SymbolUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol Read more...} */ export type Symbol = __geoscene.Symbol2D3D | __geoscene.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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-Callout3D.html Read more...} */ constructor(properties?: Callout3DProperties); /** * Creates a deep clone of the callout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-Callout3D.html#clone Read more...} */ clone(): Callout3D; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-Callout3D.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-Callout3D.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Callout3D; } interface Callout3DProperties { } export class LineCallout3D extends Callout3D { type: "line"; /** * This type of callout displays a line to connect a symbol or a label with its actual location in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html Read more...} */ constructor(properties?: LineCallout3DProperties); /** * The border settings of the callout line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#border Read more...} */ get border(): LineCallout3DBorder | nullish; set border(value: LineCallout3DBorderProperties | nullish); /** * The color of the callout line. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * The width of the callout line in points. * * @default 1px * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the callout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#clone Read more...} */ clone(): LineCallout3D; static fromJSON(json: any): LineCallout3D; } interface LineCallout3DProperties extends Callout3DProperties { /** * The border settings of the callout line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#border Read more...} */ border?: LineCallout3DBorderProperties | nullish; /** * The color of the callout line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#color Read more...} */ color?: ColorProperties | nullish; /** * The width of the callout line in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-callouts-LineCallout3D.html#size Read more...} */ size?: number | string; type?: "line"; } export interface LineCallout3DBorderProperties { color?: ColorProperties | nullish; } export interface LineCallout3DBorder extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export class CIMSymbol extends Symbol { /** * The JSON payload of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolReference CIMSymbolReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#data Read more...} */ data: CIMSymbolReference; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#type Read more...} */ readonly type: "cim"; /** * CIMSymbols are high quality, scalable, multi-layer vector symbols for features and graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html Read more...} */ constructor(properties?: CIMSymbolProperties); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#clone Read more...} */ clone(): CIMSymbol; static fromJSON(json: any): CIMSymbol; } interface CIMSymbolProperties extends SymbolProperties { /** * The JSON payload of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolReference CIMSymbolReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#data Read more...} */ data?: CIMSymbolReference; } /** * Represents animated symbol properties, a collection of symbol properties that apply when the symbol layer has animation data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMAnimatedSymbolProperties Read more...} */ export interface CIMAnimatedSymbolProperties { playAnimation?: boolean; reverseAnimation?: boolean; randomizeStartTime?: boolean; randomizeStartSeed?: number; startTimeOffset?: number; duration?: number; repeatType?: "None" | "Loop" | "Oscillate"; repeatDelay?: number; easing?: "Linear" | "EaseIn" | "EaseOut" | "EaseInOut"; } /** * Represents a background callout for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMTextSymbol CIMTextSymbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMBackgroundCallout Read more...} */ export interface CIMBackgroundCallout { type: "CIMBackgroundCallout"; backgroundSymbol: CIMPolygonSymbol; } /** * Represents a color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMColorRamp Read more...} */ export type CIMColorRamp = CIMLinearContinuousColorRamp | CIMMultipartColorRamp | CIMFixedColorRamp; /** * Represents color substitution, an ordered list of color substitutes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMColorSubstitution Read more...} */ export interface CIMColorSubstitution { oldColor: number[]; newColor: number[]; } /** * Represents a color scheme composed of discrete colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMFixedColorRamp Read more...} */ export interface CIMFixedColorRamp { type: "CIMFixedColorRamp"; colors: number[][]; } /** * Represents a geometric effect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffect Read more...} */ export type CIMGeometricEffect = | CIMGeometricEffectAddControlPoints | CIMGeometricEffectArrow | CIMGeometricEffectBuffer | CIMGeometricEffectControlMeasureLine | CIMGeometricEffectCut | CIMGeometricEffectDashes | CIMGeometricEffectDonut | CIMGeometricEffectEnclosingPolygon | CIMGeometricEffectJog | CIMGeometricEffectMove | CIMGeometricEffectOffset | CIMGeometricEffectRadial | CIMGeometricEffectRotate | CIMGeometricEffectScale | CIMGeometricEffectSuppress | CIMGeometricEffectTaperedPolygon | CIMGeometricEffectWave; /** * Represents the add control points geometric effect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectAddControlPoints Read more...} */ export interface CIMGeometricEffectAddControlPoints { type: "CIMGeometricEffectAddControlPoints"; primitiveName?: string; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectArrow Read more...} */ export interface CIMGeometricEffectArrow { type: "CIMGeometricEffectArrow"; primitiveName?: string; geometricEffectArrowType: "OpenEnded" | "Block" | "Crossed"; width: number; } /** * Represents the buffer geometric effect which creates a dynamic polygon with a specified distance around features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectBuffer Read more...} */ export interface CIMGeometricEffectBuffer { type: "CIMGeometricEffectBuffer"; primitiveName?: string; size: number; } /** * Represents the control measure line geometric effect. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectControlMeasureLine Read more...} */ export interface CIMGeometricEffectControlMeasureLine { type: "CIMGeometricEffectControlMeasureLine"; primitiveName?: string; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectCut Read more...} */ export interface CIMGeometricEffectCut { type: "CIMGeometricEffectCut"; primitiveName?: string; beginCut?: number; endCut?: number; middleCut?: number; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectDashes Read more...} */ export interface CIMGeometricEffectDashes { type: "CIMGeometricEffectDashes"; primitiveName?: string; customEndingOffset?: number; dashTemplate: number[]; lineDashEnding?: "NoConstraint" | "HalfPattern" | "HalfGap" | "FullPattern" | "FullGap" | "Custom"; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectDonut Read more...} */ export interface CIMGeometricEffectDonut { type: "CIMGeometricEffectDonut"; primitiveName?: string; option?: "Fast" | "Accurate"; width: number; } /** * Represents the enclosing polygon geometric effect which creates a dynamic polygon from the spatial extent of a line or polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectEnclosingPolygon Read more...} */ export interface CIMGeometricEffectEnclosingPolygon { type: "CIMGeometricEffectEnclosingPolygon"; primitiveName?: string; method: "ClosePath" | "ConvexHull" | "RectangularBox"; } /** * Represents the jog geometric effect which creates a dynamic line with a jog of a specified angle, position, and width in the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectJog Read more...} */ export interface CIMGeometricEffectJog { type: "CIMGeometricEffectJog"; primitiveName?: string; angle: number; length: number; position: number; } /** * Represents the move geometric effect which creates a point, line or polygon that is offset a specified distance in X and Y. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectMove Read more...} */ export interface CIMGeometricEffectMove { type: "CIMGeometricEffectMove"; primitiveName?: string; offsetX?: number; offsetY?: number; } /** * Represents the offset geometric effect which creates a dynamic line or polygon offset at a specified distance perpendicularly from a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectOffset Read more...} */ export interface CIMGeometricEffectOffset { type: "CIMGeometricEffectOffset"; primitiveName?: string; method?: "Mitered" | "Bevelled" | "Rounded" | "Square"; offset: number; option?: "Fast" | "Accurate"; } /** * Represents the radial geometric effect which creates a dynamic line of a sepcified length and angle originating from a point feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectRadial Read more...} */ export interface CIMGeometricEffectRadial { type: "CIMGeometricEffectRadial"; primitiveName?: string; angle?: number; length?: number; } /** * Represents the rotate geometric effect which creates a dynamic line or polygon rotated a specified angle from the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectRotate Read more...} */ export interface CIMGeometricEffectRotate { type: "CIMGeometricEffectRotate"; primitiveName?: string; angle: number; } /** * Represents the scale geometric effect which creates a dynamic line or polygon scaled by a specified factor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectScale Read more...} */ export interface CIMGeometricEffectScale { type: "CIMGeometricEffectScale"; primitiveName?: string; xScaleFactor?: number; yScaleFactor?: number; } /** * Represents the suppress geometric effect which creates a dynamic line that hides sections of a stroke between pairs control points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectSuppress Read more...} */ export interface CIMGeometricEffectSuppress { type: "CIMGeometricEffectSuppress"; primitiveName?: string; suppress?: boolean; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectTaperedPolygon Read more...} */ export interface CIMGeometricEffectTaperedPolygon { type: "CIMGeometricEffectTaperedPolygon"; primitiveName?: string; fromWidth?: number; toWidth?: number; length?: number; } /** * Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGeometricEffectWave Read more...} */ export interface CIMGeometricEffectWave { type: "CIMGeometricEffectWave"; primitiveName?: string; amplitude?: number; period?: number; seed?: number; waveform?: "Sinus" | "Square" | "Triangle" | "Random"; } /** * Represents a gradient fill which fills polygonal geometry with a specified color scheme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGradientFill Read more...} */ export interface CIMGradientFill { type: "CIMGradientFill"; enable: boolean; effects?: CIMGeometricEffect[]; colorLocked?: boolean; primitiveName?: string; angle?: number; colorRamp: CIMColorRamp; gradientMethod?: "Linear" | "Rectangular" | "Circular"; gradientSize?: number; gradientSizeUnits?: "Relative" | "Absolute"; gradientType?: "Discrete" | "Continuous"; interval?: number; } /** * Represents a gradient stroke which draws linear geometry with a specified color scheme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMGradientStroke Read more...} */ export interface CIMGradientStroke { type: "CIMGradientStroke"; enable: boolean; effects?: CIMGeometricEffect[]; colorLocked?: boolean; primitiveName?: string; capStyle?: "Butt" | "Round" | "Square"; joinStyle?: "Bevel" | "Round" | "Miter"; miterLimit?: number; width: number; colorRamp: CIMColorRamp; gradientMethod: "AcrossLine" | "AlongLine"; gradientSize?: number; gradientSizeUnits?: "Relative" | "Absolute"; gradientType?: "Discrete" | "Continuous"; interval?: number; } /** * Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMHatchFill Read more...} */ export interface CIMHatchFill { type: "CIMHatchFill"; effects?: CIMGeometricEffect[]; enable: boolean; colorLocked?: boolean; primitiveName?: string; lineSymbol: CIMLineSymbol; offsetX?: number; offsetY?: number; rotation?: number; separation: number; } /** * Represents a linear continuous color ramp scheme - a color ramp that has a linear transition between two colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMLinearContinuousColorRamp Read more...} */ export interface CIMLinearContinuousColorRamp { type: "CIMLinearContinuousColorRamp"; fromColor: number[]; toColor: number[]; } /** * Represents a line symbol used to draw polyline features and graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMLineSymbol Read more...} */ export interface CIMLineSymbol { type: "CIMLineSymbol"; symbolLayers: CIMSymbolLayer[]; effects?: CIMGeometricEffect[]; useRealWorldSymbolSizes?: boolean; } /** * Represents a marker graphic which is used to define vector graphics in a vector marker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerGraphic Read more...} */ export interface CIMMarkerGraphic { type: "CIMMarkerGraphic"; geometry: any; symbol: CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol | CIMTextSymbol; textString?: string; primitiveName?: string; } /** * Represents marker placement along the line which places markers that are the same size evenly along a line or polygon outline. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementAlongLineSameSize Read more...} */ export interface CIMMarkerPlacementAlongLineSameSize { type: "CIMMarkerPlacementAlongLineSameSize"; primitiveName?: string; placePerPart?: boolean; angleToLine?: boolean; offset?: number; customEndingOffset?: number; endings?: "NoConstraint" | "WithMarkers" | "WithFullGap" | "WithHalfGap" | "Custom"; offsetAlongLine?: number; placementTemplate: number[]; } /** * Represents marker placement at extremities which places markers at only one or both endpoints of a line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementAtExtremities Read more...} */ export interface CIMMarkerPlacementAtExtremities { type: "CIMMarkerPlacementAtExtremities"; primitiveName?: string; placePerPart?: boolean; angleToLine?: boolean; offset?: number; extremityPlacement?: "Both" | "JustBegin" | "JustEnd" | "None"; offsetAlongLine?: number; } /** * Represents marker placement at ratio positions which places a set number of markers along the line or the outline of a polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementAtRatioPositions Read more...} */ export interface CIMMarkerPlacementAtRatioPositions { type: "CIMMarkerPlacementAtRatioPositions"; primitiveName?: string; placePerPart?: boolean; angleToLine?: boolean; offset?: number; beginPosition?: number; endPosition?: number; flipFirst?: boolean; positionArray: number[]; } /** * Represents marker placement inside a polygon which defines how a polygon is filled with a pattern of markers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementInsidePolygon Read more...} */ export interface CIMMarkerPlacementInsidePolygon { type: "CIMMarkerPlacementInsidePolygon"; primitiveName?: string; placePerPart?: boolean; gridAngle?: number; gridType?: "Fixed" | "Random"; offsetX?: number; offsetY?: number; shiftOddRows?: boolean; stepX: number; stepY: number; randomness?: number; seed?: number; clipping?: "ClipAtBoundary"; } /** * Represents a marker placement on the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementOnLine Read more...} */ export interface CIMMarkerPlacementOnLine { type: "CIMMarkerPlacementOnLine"; primitiveName?: string; placePerPart?: boolean; angleToLine?: boolean; offset?: number; relativeTo?: "LineMiddle" | "LineBeginning" | "LineEnd" | "SegmentMidpoint"; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementOnVertices Read more...} */ export interface CIMMarkerPlacementOnVertices { type: "CIMMarkerPlacementOnVertices"; primitiveName?: string; placePerPart?: boolean; angleToLine?: boolean; offset?: number; placeOnControlPoints?: boolean; placeOnEndPoints?: boolean; placeOnRegularVertices?: boolean; } /** * Represents marker placement polygon center which defines how a single marker will be placed within the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMarkerPlacementPolygonCenter Read more...} */ export interface CIMMarkerPlacementPolygonCenter { type: "CIMMarkerPlacementPolygonCenter"; primitiveName?: string; placePerPart?: boolean; method?: "OnPolygon" | "CenterOfMass" | "BoundingBoxCenter"; offsetX?: number; offsetY?: number; clipAtBoundary?: boolean; } /** * Represents a multipart color ramp scheme - a color ramp defined by combining two or more continuous or fixed ramps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMMultipartColorRamp Read more...} */ export interface CIMMultipartColorRamp { type: "CIMMultipartColorRamp"; colorRamps: CIMColorRamp[]; weights: number[]; } /** * Represents a picture fill which fills polygonal geometry with a picture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMPictureFill Read more...} */ export interface CIMPictureFill { type: "CIMPictureFill"; effects?: CIMGeometricEffect[]; enable: boolean; colorLocked?: boolean; primitiveName?: string; url: string; offsetX?: number; offsetY?: number; rotation?: number; scaleX?: number; height?: number; colorSubstitutions?: CIMColorSubstitution[]; tintColor?: number[]; } /** * Represents a picture marker created from a raster (bitmapped) image file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMPictureMarker Read more...} */ export interface CIMPictureMarker { type: "CIMPictureMarker"; enable: boolean; url: string; size: number; colorLocked?: boolean; effects?: CIMGeometricEffect[]; primitiveName?: string; anchorPoint?: CIMPictureMarkerAnchorPoint; anchorPointUnits?: "Relative" | "Absolute"; offsetX?: number; offsetY?: number; rotateClockwise?: boolean; rotation?: number; markerPlacement?: MarkerPlacement; scaleX?: number; height?: number; colorSubstitutions?: CIMColorSubstitution[]; tintColor?: number[]; animatedSymbolProperties?: CIMAnimatedSymbolProperties; animations?: CIMSymbolAnimation[]; } /** * Represents a picture stroke which draws linear geometry with a repeating image file. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMPictureStroke Read more...} */ export interface CIMPictureStroke { type: "CIMPictureStroke"; enable: boolean; colorLocked?: boolean; primitiveName?: string; url: string; colorSubstitutions?: CIMColorSubstitution[]; tintColor?: number[]; width: number; capStyle?: "Butt" | "Round" | "Square"; joinStyle?: "Bevel" | "Round" | "Miter"; miterLimit?: number; effects?: CIMGeometricEffect[]; } /** * Represents a point symbol used to draw point features and graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMPointSymbol Read more...} */ export interface CIMPointSymbol { type: "CIMPointSymbol"; symbolLayers?: CIMSymbolLayer[]; angle?: number; angleAlignment?: "Display" | "Map"; effects?: CIMGeometricEffect[]; primitiveName?: string; scaleX?: number; useRealWorldSymbolSizes?: boolean; animations?: CIMSymbolAnimation[]; } /** * Represents a polygon symbol used to draw polygon features and graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMPolygonSymbol Read more...} */ export interface CIMPolygonSymbol { type: "CIMPolygonSymbol"; symbolLayers: CIMSymbolLayer[]; effects?: CIMGeometricEffect[]; useRealWorldSymbolSizes?: boolean; } /** * Represents a solid fill which fills polygonal geometry with a single solid color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSolidFill Read more...} */ export interface CIMSolidFill { type: "CIMSolidFill"; effects?: CIMGeometricEffect[]; enable: boolean; colorLocked?: boolean; primitiveName?: string; color: number[]; animations?: CIMSymbolAnimation[]; } /** * Represents a solid stroke which draws linear geometry with a single solid color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSolidStroke Read more...} */ export interface CIMSolidStroke { type: "CIMSolidStroke"; enable: boolean; colorLocked?: boolean; primitiveName?: string; color: number[]; width: number; capStyle?: "Butt" | "Round" | "Square"; joinStyle?: "Bevel" | "Round" | "Miter"; miterLimit?: number; effects?: CIMGeometricEffect[]; animations?: CIMSymbolAnimation[]; } /** * Represents a symbol animation used to animate the appearance of a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimation Read more...} */ export type CIMSymbolAnimation = | CIMSymbolAnimationSize | CIMSymbolAnimationScale | CIMSymbolAnimationColor | CIMSymbolAnimationTransparency | CIMSymbolAnimationRotation | CIMSymbolAnimationOffset; /** * Represents a symbol animation that changes the color of a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationColor Read more...} */ export interface CIMSymbolAnimationColor { type: "CIMSymbolAnimationColor"; toColor: Color; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol animation that offsets a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationOffset Read more...} */ export interface CIMSymbolAnimationOffset { type: "CIMSymbolAnimationOffset"; offsetX?: number; offsetY?: number; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol animation that rotates a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationRotation Read more...} */ export interface CIMSymbolAnimationRotation { type: "CIMSymbolAnimationRotation"; toRotation: number; rotateClockwise?: boolean; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol animation that scales a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationScale Read more...} */ export interface CIMSymbolAnimationScale { type: "CIMSymbolAnimationScale"; scaleFactor: number; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol animation that changes the size of a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationSize Read more...} */ export interface CIMSymbolAnimationSize { type: "CIMSymbolAnimationSize"; toSize: number; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol animation that changes the transparency of a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolAnimationTransparency Read more...} */ export interface CIMSymbolAnimationTransparency { type: "CIMSymbolAnimationTransparency"; toTransparency?: number; animatedSymbolProperties?: CIMAnimatedSymbolProperties; } /** * Represents a symbol layer, the component that makes up a symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolLayer Read more...} */ export type CIMSymbolLayer = | CIMHatchFill | CIMPictureFill | CIMPictureMarker | CIMPictureStroke | CIMSolidFill | CIMSolidStroke | CIMVectorMarker | CIMGradientStroke | CIMGradientFill; /** * Represents a symbol reference from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#data data} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMSymbolReference Read more...} */ export interface CIMSymbolReference { type: "CIMSymbolReference"; primitiveOverrides?: PrimitiveOverride[] | nullish; symbol?: CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol; minScale?: number; maxScale?: number; } /** * Represents a text symbol which is used to draw text graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMTextSymbol Read more...} */ export interface CIMTextSymbol { type: "CIMTextSymbol"; angle?: number; fontFamilyName: string; fontStyleName?: "Regular" | "Bold" | "Italic"; haloSize?: number; haloSymbol?: CIMPolygonSymbol; height: number; horizontalAlignment?: "Left" | "Right" | "Center"; offsetX?: number; offsetY?: number; strikethrough?: boolean; symbol: CIMPolygonSymbol; underline?: boolean; verticalAlignment?: "Top" | "Center" | "Baseline" | "Bottom"; callout?: CIMBackgroundCallout; } /** * Represents a vector marker which can represent vector graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#CIMVectorMarker Read more...} */ export interface CIMVectorMarker { type: "CIMVectorMarker"; effects?: CIMGeometricEffect[]; enable: boolean; colorLocked?: boolean; primitiveName?: string; size: number; anchorPoint?: CIMVectorMarkerAnchorPoint; anchorPointUnits?: "Relative" | "Absolute"; offsetX?: number; offsetY?: number; rotateClockwise?: boolean; rotation?: number; markerPlacement?: MarkerPlacement; frame: Envelope; markerGraphics: CIMMarkerGraphic[]; scaleSymbolsProportionally?: boolean; respectFrame?: boolean; animations?: CIMSymbolAnimation[]; } /** * An envelope is a rectangle defined by a range of values for each coordinate and attribute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#Envelope Read more...} */ export interface Envelope { xmin: number; xmax: number; ymin: number; ymax: number; } /** * Represents a marker placement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#MarkerPlacement Read more...} */ export type MarkerPlacement = | CIMMarkerPlacementAlongLineSameSize | CIMMarkerPlacementAtExtremities | CIMMarkerPlacementAtRatioPositions | CIMMarkerPlacementInsidePolygon | CIMMarkerPlacementOnLine | CIMMarkerPlacementOnVertices | CIMMarkerPlacementPolygonCenter; /** * Represents a primitive override. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html#PrimitiveOverride Read more...} */ export interface PrimitiveOverride { type?: "CIMPrimitiveOverride"; primitiveName: string; propertyName: string; valueExpressionInfo?: PrimitiveOverrideValueExpressionInfo; } export interface CIMPictureMarkerAnchorPoint { x?: any; y?: any; } export interface CIMVectorMarkerAnchorPoint { x?: any; y?: any; } export interface PrimitiveOverrideValueExpressionInfo { type: "CIMExpressionInfo"; title?: string; expression: string; name?: string; returnType?: "Default" | "String" | "Numeric"; } export interface Edges3D extends Accessor, JSONSupport { } export class Edges3D { /** * Edges3D is the base class for symbol classes that add edge rendering visualization to existing symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html Read more...} */ constructor(properties?: Edges3DProperties); /** * The color of the edges. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * A size in points by which to extend edges beyond their original end points. * * @default "0" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#extensionLength Read more...} */ get extensionLength(): number; set extensionLength(value: number | string); /** * The size of the edges in points. * * @default 1px * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the edges. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#clone Read more...} */ clone(): Edges3D; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Edges3D; } interface Edges3DProperties { /** * The color of the edges. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#color Read more...} */ color?: ColorProperties | nullish; /** * A size in points by which to extend edges beyond their original end points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#extensionLength Read more...} */ extensionLength?: number | string; /** * The size of the edges in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-Edges3D.html#size Read more...} */ size?: number | string; } export class SketchEdges3D extends Edges3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SketchEdges3D.html#type Read more...} */ type: "sketch"; /** * SketchEdges3D is a symbol type that visualizes edges of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html 3D Object SceneLayers}, extruded * polygons or mesh geometries with a sketched line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SketchEdges3D.html Read more...} */ constructor(properties?: SketchEdges3DProperties); /** * Creates a deep clone of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SketchEdges3D.html#clone Read more...} */ clone(): SketchEdges3D; static fromJSON(json: any): SketchEdges3D; } interface SketchEdges3DProperties extends Edges3DProperties { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SketchEdges3D.html#type Read more...} */ type?: "sketch"; } export class SolidEdges3D extends Edges3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SolidEdges3D.html#type Read more...} */ type: "solid"; /** * SolidEdges3D is a symbol type that visualizes edges of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html 3D Object SceneLayers}, extruded * polygons or mesh geometries with a solid line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SolidEdges3D.html Read more...} */ constructor(properties?: SolidEdges3DProperties); /** * Creates a deep clone of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SolidEdges3D.html#clone Read more...} */ clone(): SolidEdges3D; static fromJSON(json: any): SolidEdges3D; } interface SolidEdges3DProperties extends Edges3DProperties { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-edges-SolidEdges3D.html#type Read more...} */ type?: "solid"; } export class ExtrudeSymbol3DLayer extends Symbol3DLayer { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#castShadows Read more...} */ castShadows: boolean; /** * The height of the extrusion in meters. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#size Read more...} */ size: number; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#type Read more...} */ readonly type: "extrude"; /** * ExtrudeSymbol3DLayer is used to render {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} geometries * by extruding them upward from the ground, creating a 3D volumetric object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html Read more...} */ constructor(properties?: ExtrudeSymbol3DLayerProperties); /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#edges Read more...} */ get edges(): Edges3D | nullish; set edges(value: Edges3DProperties | nullish); /** * The material used to shade the extrusion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#material Read more...} */ get material(): ExtrudeSymbol3DLayerMaterial | nullish; set material(value: ExtrudeSymbol3DLayerMaterialProperties | nullish); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#clone Read more...} */ clone(): ExtrudeSymbol3DLayer; static fromJSON(json: any): ExtrudeSymbol3DLayer; } interface ExtrudeSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#castShadows Read more...} */ castShadows?: boolean; /** * Sets the contour edges on polygons symbolized with ExtrudeSymbol3DLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#edges Read more...} */ edges?: Edges3DProperties | nullish; /** * The material used to shade the extrusion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#material Read more...} */ material?: ExtrudeSymbol3DLayerMaterialProperties | nullish; /** * The height of the extrusion in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ExtrudeSymbol3DLayer.html#size Read more...} */ size?: number; } export interface ExtrudeSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface ExtrudeSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export class FillSymbol extends Symbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html#type Read more...} */ readonly type: "simple-fill" | "picture-fill"; /** * Fill symbols are used to draw {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} graphics in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} * in a 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html Read more...} */ constructor(properties?: FillSymbolProperties); /** * The outline of the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html#outline Read more...} */ get outline(): SimpleLineSymbol | nullish; set outline(value: (SimpleLineSymbolProperties & { type?: "simple-line" }) | nullish); static fromJSON(json: any): FillSymbol; } interface FillSymbolProperties extends SymbolProperties { /** * The outline of the polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol.html#outline Read more...} */ outline?: (SimpleLineSymbolProperties & { type?: "simple-line" }) | nullish; } export class FillSymbol3DLayer extends Symbol3DLayer { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#castShadows Read more...} */ castShadows: boolean; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#type Read more...} */ readonly type: "fill"; /** * FillSymbol3DLayer is used to render the surfaces of flat 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} * geometries and 3D volumetric meshes in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html Read more...} */ constructor(properties?: FillSymbol3DLayerProperties); /** * Sets the contour edges on 3D Objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#edges Read more...} */ get edges(): Edges3D | nullish; set edges(value: Edges3DProperties | nullish); /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#material Read more...} */ get material(): FillSymbol3DLayerMaterial | nullish; set material(value: FillSymbol3DLayerMaterialProperties | nullish); /** * The outline used to draw a line around the filled geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#outline Read more...} */ get outline(): FillSymbol3DLayerOutline | nullish; set outline(value: FillSymbol3DLayerOutlineProperties | nullish); /** * The pattern used to render the polygon fill. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#pattern Read more...} */ get pattern(): StylePattern3D | nullish; set pattern(value: (StylePattern3DProperties & { type: "style" }) | nullish); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#clone Read more...} */ clone(): FillSymbol3DLayer; static fromJSON(json: any): FillSymbol3DLayer; } interface FillSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#castShadows Read more...} */ castShadows?: boolean; /** * Sets the contour edges on 3D Objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#edges Read more...} */ edges?: Edges3DProperties | nullish; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#material Read more...} */ material?: FillSymbol3DLayerMaterialProperties | nullish; /** * The outline used to draw a line around the filled geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#outline Read more...} */ outline?: FillSymbol3DLayerOutlineProperties | nullish; /** * The pattern used to render the polygon fill. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-FillSymbol3DLayer.html#pattern Read more...} */ pattern?: (StylePattern3DProperties & { type: "style" }) | nullish; } export interface FillSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; colorMixMode?: "tint" | "replace" | "multiply" | nullish; } export interface FillSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); colorMixMode: "tint" | "replace" | "multiply" | nullish; } export interface FillSymbol3DLayerOutlineProperties { color?: ColorProperties | nullish; size?: number | string; pattern?: (LineStylePattern3DProperties & { type: "style" }) | nullish; patternCap?: "butt" | "round" | "square"; } export interface FillSymbol3DLayerOutline extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); get size(): number; set size(value: number | string); get pattern(): LineStylePattern3D | nullish; set pattern(value: (LineStylePattern3DProperties & { type: "style" }) | nullish); patternCap: "butt" | "round" | "square"; } export interface Font extends Accessor, JSONSupport { } export class Font { /** * The text decoration. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#decoration Read more...} */ decoration: "underline" | "line-through" | "none"; /** * The font family of the text. * * @default "sans-serif" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#family Read more...} */ family: string; /** * The text style. * * @default "normal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#style Read more...} */ style: "normal" | "italic" | "oblique"; /** * The text weight. * * @default "normal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#weight Read more...} */ weight: "normal" | "bold" | "bolder" | "lighter"; /** * The font used to display {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html 2D text symbols} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html 3D text symbols}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html Read more...} */ constructor(properties?: FontProperties); /** * The font size in points. * * @default 9 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the font object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#clone Read more...} */ clone(): Font; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Font; } interface FontProperties { /** * The text decoration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#decoration Read more...} */ decoration?: "underline" | "line-through" | "none"; /** * The font family of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#family Read more...} */ family?: string; /** * The font size in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#size Read more...} */ size?: number | string; /** * The text style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#style Read more...} */ style?: "normal" | "italic" | "oblique"; /** * The text weight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html#weight Read more...} */ weight?: "normal" | "bold" | "bolder" | "lighter"; } export class IconSymbol3DLayer extends Symbol3DLayer { /** * The positioning of the icon relative to the geometry. * * @default "center" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchor Read more...} */ anchor: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"; /** * The clockwise rotation angle of the icon in degrees. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#angle Read more...} */ angle: number; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#type Read more...} */ readonly type: "icon"; /** * IconSymbol3DLayer is used to render {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} geometries * using a flat 2D icon (e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html Read more...} */ constructor(properties?: IconSymbol3DLayerProperties); /** * Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchor anchor} relative to the center of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchorPosition Read more...} */ get anchorPosition(): IconSymbol3DLayerAnchorPosition; set anchorPosition(value: IconSymbol3DLayerAnchorPositionProperties); /** * The material used to shade the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#material Read more...} */ get material(): IconSymbol3DLayerMaterial | nullish; set material(value: IconSymbol3DLayerMaterialProperties | nullish); /** * The outline of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#outline Read more...} */ get outline(): IconSymbol3DLayerOutline | nullish; set outline(value: IconSymbol3DLayerOutlineProperties | nullish); /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. * * @default { primitive: "circle" } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#resource Read more...} */ get resource(): IconSymbol3DLayerResource | nullish; set resource(value: IconSymbol3DLayerResourceProperties | nullish); /** * The size of the icon in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#clone Read more...} */ clone(): IconSymbol3DLayer; static fromJSON(json: any): IconSymbol3DLayer; } interface IconSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The positioning of the icon relative to the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchor Read more...} */ anchor?: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"; /** * Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchor anchor} relative to the center of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#anchorPosition Read more...} */ anchorPosition?: IconSymbol3DLayerAnchorPositionProperties; /** * The clockwise rotation angle of the icon in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#angle Read more...} */ angle?: number; /** * The material used to shade the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#material Read more...} */ material?: IconSymbol3DLayerMaterialProperties | nullish; /** * The outline of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#outline Read more...} */ outline?: IconSymbol3DLayerOutlineProperties | nullish; /** * The shape (`primitive`) or image URL (`href`) used to visualize the features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#resource Read more...} */ resource?: IconSymbol3DLayerResourceProperties | nullish; /** * The size of the icon in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-IconSymbol3DLayer.html#size Read more...} */ size?: number | string; } export interface IconSymbol3DLayerAnchorPositionProperties { x?: number; y?: number; } export interface IconSymbol3DLayerAnchorPosition extends AnonymousAccessor { x: number; y: number; } export interface IconSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface IconSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export interface IconSymbol3DLayerOutlineProperties { color?: ColorProperties | nullish; size?: number | string; } export interface IconSymbol3DLayerOutline extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); get size(): number; set size(value: number | string); } export interface IconSymbol3DLayerResourceProperties { primitive?: "x" | "cross" | "square" | "circle" | "triangle" | "kite" | nullish; href?: string | nullish; } export interface IconSymbol3DLayerResource extends AnonymousAccessor { primitive: "x" | "cross" | "square" | "circle" | "triangle" | "kite" | nullish; href: string | nullish; } export class LabelSymbol3D extends Symbol3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#type Read more...} */ readonly type: "label-3d"; /** * LabelSymbol3D is used to render labels for features from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html Read more...} */ constructor(properties?: LabelSymbol3DProperties); /** * Settings for adding a callout visualization to the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#callout Read more...} */ get callout(): Callout3D | nullish; set callout(value: Callout3DProperties | nullish); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection; set symbolLayers(value: CollectionProperties); /** * Shifts the symbol along the vertical world axis by a given height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#verticalOffset Read more...} */ get verticalOffset(): Symbol3DVerticalOffset | nullish; set verticalOffset(value: Symbol3DVerticalOffsetProperties | nullish); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#clone Read more...} */ clone(): LabelSymbol3D; static fromJSON(json: any): LabelSymbol3D; } interface LabelSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#callout Read more...} */ callout?: Callout3DProperties | nullish; /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#symbolLayers Read more...} */ symbolLayers?: CollectionProperties; /** * Shifts the symbol along the vertical world axis by a given height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LabelSymbol3D.html#verticalOffset Read more...} */ verticalOffset?: Symbol3DVerticalOffsetProperties | nullish; } export interface LineStyleMarker3D extends Accessor, Clonable { } export class LineStyleMarker3D { /** * Indicates where the marker is placed. * * @default "begin-end" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#placement Read more...} */ placement: "begin" | "end" | "begin-end"; /** * Style of the marker. * * @default "arrow" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#style Read more...} */ style: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The type of marker applied to a line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#type Read more...} */ readonly type: "style"; /** * LineStyleMarker3D is used for rendering a simple marker graphic on * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html LineSymbol3DLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html Read more...} */ constructor(properties?: LineStyleMarker3DProperties); /** * The color of the marker. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#clone Read more...} */ clone(): this; } interface LineStyleMarker3DProperties { /** * The color of the marker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#color Read more...} */ color?: ColorProperties | nullish; /** * Indicates where the marker is placed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#placement Read more...} */ placement?: "begin" | "end" | "begin-end"; /** * Style of the marker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#style Read more...} */ style?: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The type of marker applied to a line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineStyleMarker3D.html#type Read more...} */ type?: "style"; } export class LineSymbol extends Symbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol.html#type Read more...} */ type: "simple-line"; /** * Line symbols are used to draw {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} features in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} in a 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol.html Read more...} */ constructor(properties?: LineSymbolProperties); /** * The width of the symbol in points. * * @default 0.75 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol.html#width Read more...} */ get width(): number; set width(value: number | string); static fromJSON(json: any): LineSymbol; } interface LineSymbolProperties extends SymbolProperties { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol.html#type Read more...} */ type?: "simple-line"; /** * The width of the symbol in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol.html#width Read more...} */ width?: number | string; } export class LineSymbol3D extends Symbol3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html#type Read more...} */ readonly type: "line-3d"; /** * LineSymbol3D is used to render features with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} geometry * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html Read more...} */ constructor(properties?: LineSymbol3DProperties); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection; set symbolLayers(value: CollectionProperties< (LineSymbol3DLayerProperties & { type: "line" }) | (PathSymbol3DLayerProperties & { type: "path" }) >); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html#clone Read more...} */ clone(): LineSymbol3D; static fromJSON(json: any): LineSymbol3D; } interface LineSymbol3DProperties extends Symbol3DProperties { /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html#symbolLayers Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#cap Read more...} */ cap: "butt" | "round" | "square"; /** * The style used to draw the intersection of two line segments within a line geometry. * * @default "miter" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#join Read more...} */ join: "miter" | "round" | "bevel"; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#type Read more...} */ readonly type: "line"; /** * LineSymbol3DLayer renders {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} geometries * using a flat 2D line with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html LineSymbol3D} * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html Read more...} */ constructor(properties?: LineSymbol3DLayerProperties); /** * Optional markers to be placed at the start and/or end of each line geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#marker Read more...} */ get marker(): LineStyleMarker3D | nullish; set marker(value: (LineStyleMarker3DProperties & { type: "style" }) | nullish); /** * The material used to shade the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#material Read more...} */ get material(): LineSymbol3DLayerMaterial | nullish; set material(value: LineSymbol3DLayerMaterialProperties | nullish); /** * The pattern used to render the line stroke. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#pattern Read more...} */ get pattern(): LineStylePattern3D | nullish; set pattern(value: (LineStylePattern3DProperties & { type: "style" }) | nullish); /** * The width of the line in points. * * @default "1px" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#clone Read more...} */ clone(): LineSymbol3DLayer; static fromJSON(json: any): LineSymbol3DLayer; } interface LineSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The style used to draw the endpoint of a line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#cap Read more...} */ cap?: "butt" | "round" | "square"; /** * The style used to draw the intersection of two line segments within a line geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#join Read more...} */ join?: "miter" | "round" | "bevel"; /** * Optional markers to be placed at the start and/or end of each line geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#marker Read more...} */ marker?: (LineStyleMarker3DProperties & { type: "style" }) | nullish; /** * The material used to shade the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#material Read more...} */ material?: LineSymbol3DLayerMaterialProperties | nullish; /** * The pattern used to render the line stroke. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#pattern Read more...} */ pattern?: (LineStylePattern3DProperties & { type: "style" }) | nullish; /** * The width of the line in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3DLayer.html#size Read more...} */ size?: number | string; } export interface LineSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface LineSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export class LineSymbolMarker extends Accessor { /** * The placement of the marker(s) on the line. * * @default "begin-end" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#placement Read more...} */ placement: "begin" | "end" | "begin-end"; /** * The marker style. * * @default "arrow" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#style Read more...} */ style: "arrow" | "circle" | "square" | "diamond" | "cross" | "x"; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#type Read more...} */ readonly type: "line-marker"; /** * LineSymbolMarker is used for rendering a simple marker graphic on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html Read more...} */ constructor(properties?: LineSymbolMarkerProperties); /** * The color of the marker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); } interface LineSymbolMarkerProperties { /** * The color of the marker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#color Read more...} */ color?: ColorProperties; /** * The placement of the marker(s) on the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#placement Read more...} */ placement?: "begin" | "end" | "begin-end"; /** * The marker style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbolMarker.html#style Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#angle Read more...} */ angle: number; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#type Read more...} */ readonly type: "simple-marker" | "picture-marker"; /** * Marker symbols are used to draw {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} graphics in * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} or individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} * in a 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html Read more...} */ constructor(properties?: MarkerSymbolProperties); /** * The offset on the x-axis in points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#xoffset Read more...} */ get xoffset(): number; set xoffset(value: number | string); /** * The offset on the y-axis in points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#yoffset Read more...} */ get yoffset(): number; set yoffset(value: number | string); static fromJSON(json: any): MarkerSymbol; } interface MarkerSymbolProperties extends SymbolProperties { /** * The angle of the marker relative to the screen in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#angle Read more...} */ angle?: number; /** * The offset on the x-axis in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#xoffset Read more...} */ xoffset?: number | string; /** * The offset on the y-axis in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MarkerSymbol.html#yoffset Read more...} */ yoffset?: number | string; } export class MeshSymbol3D extends Symbol3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MeshSymbol3D.html#type Read more...} */ readonly type: "mesh-3d"; /** * MeshSymbol3D is used to render 3D mesh features in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer} * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MeshSymbol3D.html Read more...} */ constructor(properties?: MeshSymbol3DProperties); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MeshSymbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection; set symbolLayers(value: CollectionProperties); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MeshSymbol3D.html#clone Read more...} */ clone(): MeshSymbol3D; static fromJSON(json: any): MeshSymbol3D; } interface MeshSymbol3DProperties extends Symbol3DProperties { /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-MeshSymbol3D.html#symbolLayers Read more...} */ symbolLayers?: CollectionProperties; } export class ObjectSymbol3DLayer extends Symbol3DLayer { /** * The positioning of the symbol relative to the geometry. * * @default "origin" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchor Read more...} */ anchor: "center" | "top" | "bottom" | "origin" | "relative" | nullish; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#castShadows Read more...} */ castShadows: boolean; /** * The depth, or diameter from north to south, of the object in meters. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#depth Read more...} */ depth: number | nullish; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#heading Read more...} */ heading: number | nullish; /** * The height of the object in meters. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#height Read more...} */ height: number | nullish; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#roll Read more...} */ roll: number | nullish; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#tilt Read more...} */ tilt: number | nullish; /** * The object type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#type Read more...} */ readonly type: "object"; /** * The width, or diameter from east to west, of the object in meters. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#width Read more...} */ width: number | nullish; /** * ObjectSymbol3DLayer is used to render {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} geometries * using a volumetric 3D shape (e.g., a sphere or cylinder) with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html PointSymbol3D} * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html Read more...} */ constructor(properties?: ObjectSymbol3DLayerProperties); /** * Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchor anchor} relative to the center of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#resource symbol layer resource}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchorPosition Read more...} */ get anchorPosition(): ObjectSymbol3DLayerAnchorPosition | nullish; set anchorPosition(value: ObjectSymbol3DLayerAnchorPositionProperties | nullish); /** * The material used to shade the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#material Read more...} */ get material(): ObjectSymbol3DLayerMaterial | nullish; set material(value: ObjectSymbol3DLayerMaterialProperties | nullish); /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the * points. * * @default { primitive: "sphere" } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#resource Read more...} */ get resource(): ObjectSymbol3DLayerResource | nullish; set resource(value: ObjectSymbol3DLayerResourceProperties | nullish); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#clone Read more...} */ clone(): ObjectSymbol3DLayer; static fromJSON(json: any): ObjectSymbol3DLayer; } interface ObjectSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The positioning of the symbol relative to the geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchor Read more...} */ anchor?: "center" | "top" | "bottom" | "origin" | "relative" | nullish; /** * Defines the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchor anchor} relative to the center of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#resource symbol layer resource}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#anchorPosition Read more...} */ anchorPosition?: ObjectSymbol3DLayerAnchorPositionProperties | nullish; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#castShadows Read more...} */ castShadows?: boolean; /** * The depth, or diameter from north to south, of the object in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#depth Read more...} */ depth?: number | nullish; /** * The clockwise rotation of the symbol in the horizontal plane (i.e., around the z axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#heading Read more...} */ heading?: number | nullish; /** * The height of the object in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#height Read more...} */ height?: number | nullish; /** * The material used to shade the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#material Read more...} */ material?: ObjectSymbol3DLayerMaterialProperties | nullish; /** * The primitive shape (`primitive`) or external 3D model (`href`) used to visualize the * points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#resource Read more...} */ resource?: ObjectSymbol3DLayerResourceProperties | nullish; /** * The rotation of the symbol in the lateral vertical plane (i.e., around the y axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#roll Read more...} */ roll?: number | nullish; /** * The rotation of the symbol in the longitudinal vertical plane (i.e., around the x axis). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#tilt Read more...} */ tilt?: number | nullish; /** * The width, or diameter from east to west, of the object in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-ObjectSymbol3DLayer.html#width Read more...} */ width?: number | nullish; } export interface ObjectSymbol3DLayerAnchorPositionProperties { x?: number; y?: number; z?: number; } export interface ObjectSymbol3DLayerAnchorPosition extends AnonymousAccessor { x: number; y: number; z: number; } export interface ObjectSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface ObjectSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export interface ObjectSymbol3DLayerResourceProperties { primitive?: "diamond" | "sphere" | "cylinder" | "cube" | "cone" | "inverted-cone" | "tetrahedron" | nullish; href?: string | nullish; } export interface ObjectSymbol3DLayerResource extends AnonymousAccessor { primitive: "diamond" | "sphere" | "cylinder" | "cube" | "cone" | "inverted-cone" | "tetrahedron" | nullish; href: string | nullish; } export class PathSymbol3DLayer extends Symbol3DLayer { /** * Defines offset of the path cross section relative to the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} geometry. * * @default "center" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#anchor Read more...} */ anchor: "center" | "bottom" | "top"; /** * Controls the shape at the start and end point of the path. * * @default "butt" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#cap Read more...} */ cap: "none" | "butt" | "square" | "round"; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#castShadows Read more...} */ castShadows: boolean; /** * The vertical dimension of the cross-section of the path in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#height Read more...} */ height: number | nullish; /** * Controls the shape of the connection between two segments of the path. * * @default "miter" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#join Read more...} */ join: "miter" | "bevel" | "round"; /** * Cross-section profile of the path geometry. * * @default "circle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profile Read more...} */ profile: "circle" | "quad"; /** * Defines how the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profile profile} is rotated as it is extruded along the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} * geometry. * * @default "all" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profileRotation Read more...} */ profileRotation: "heading" | "all"; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#type Read more...} */ readonly type: "path"; /** * The horizontal dimension of the cross-section of the path in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#width Read more...} */ width: number | nullish; /** * PathSymbol3DLayer renders {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} geometries * by extruding a 2D profile along the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html Read more...} */ constructor(properties?: PathSymbol3DLayerProperties); /** * The material used to shade the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#material Read more...} */ get material(): PathSymbol3DLayerMaterial | nullish; set material(value: PathSymbol3DLayerMaterialProperties | nullish); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#clone Read more...} */ clone(): PathSymbol3DLayer; static fromJSON(json: any): PathSymbol3DLayer; } interface PathSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * Defines offset of the path cross section relative to the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#anchor Read more...} */ anchor?: "center" | "bottom" | "top"; /** * Controls the shape at the start and end point of the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#cap Read more...} */ cap?: "none" | "butt" | "square" | "round"; /** * Indicates whether the symbol layer geometry casts shadows in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#castShadows Read more...} */ castShadows?: boolean; /** * The vertical dimension of the cross-section of the path in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#height Read more...} */ height?: number | nullish; /** * Controls the shape of the connection between two segments of the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#join Read more...} */ join?: "miter" | "bevel" | "round"; /** * The material used to shade the path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#material Read more...} */ material?: PathSymbol3DLayerMaterialProperties | nullish; /** * Cross-section profile of the path geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profile Read more...} */ profile?: "circle" | "quad"; /** * Defines how the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profile profile} is rotated as it is extruded along the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} * geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#profileRotation Read more...} */ profileRotation?: "heading" | "all"; /** * The horizontal dimension of the cross-section of the path in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PathSymbol3DLayer.html#width Read more...} */ width?: number | nullish; } export interface PathSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface PathSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export interface LineStylePattern3D extends Accessor, JSONSupport { } export class LineStylePattern3D { /** * The pattern style. * * @default "solid" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#style Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#type Read more...} */ readonly type: "style"; /** * Renders lines with predefined style patterns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html Read more...} */ constructor(properties?: LineStylePattern3DProperties); /** * Creates a deep clone of the pattern. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#clone Read more...} */ clone(): LineStylePattern3D; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LineStylePattern3D; } interface LineStylePattern3DProperties { /** * The pattern style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-LineStylePattern3D.html#style Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#style Read more...} */ style: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; /** * The pattern type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#type Read more...} */ readonly type: "style"; /** * Renders polygons with predefined style pattern fills. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html Read more...} */ constructor(properties?: StylePattern3DProperties); /** * Creates a deep clone of the pattern. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#clone Read more...} */ clone(): StylePattern3D; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): StylePattern3D; } interface StylePattern3DProperties { /** * The fill style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-patterns-StylePattern3D.html#style Read more...} */ style?: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; } export class PictureFillSymbol extends FillSymbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#type Read more...} */ readonly type: "picture-fill"; /** * The URL to the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#url Read more...} */ url: string | nullish; /** * The scale factor on the x axis of the symbol. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#xscale Read more...} */ xscale: number; /** * The scale factor on the y axis of the symbol. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#yscale Read more...} */ yscale: number; /** * PictureFillSymbol uses an image in a repeating pattern to symbolize polygon features in a * 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html Read more...} */ constructor(properties?: PictureFillSymbolProperties); /** * The height of the image in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#height Read more...} */ get height(): number; set height(value: number | string); /** * The width of the image in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#width Read more...} */ get width(): number; set width(value: number | string); /** * The offset on the x-axis in points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#xoffset Read more...} */ get xoffset(): number; set xoffset(value: number | string); /** * The offset on the y-axis in pixels or points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#yoffset Read more...} */ get yoffset(): number; set yoffset(value: number | string); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#clone Read more...} */ clone(): PictureFillSymbol; static fromJSON(json: any): PictureFillSymbol; } interface PictureFillSymbolProperties extends FillSymbolProperties { /** * The height of the image in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#height Read more...} */ height?: number | string; /** * The URL to the image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#url Read more...} */ url?: string | nullish; /** * The width of the image in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#width Read more...} */ width?: number | string; /** * The offset on the x-axis in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#xoffset Read more...} */ xoffset?: number | string; /** * The scale factor on the x axis of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#xscale Read more...} */ xscale?: number; /** * The offset on the y-axis in pixels or points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#yoffset Read more...} */ yoffset?: number | string; /** * The scale factor on the y axis of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureFillSymbol.html#yscale Read more...} */ yscale?: number; } export class PictureMarkerSymbol extends MarkerSymbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#type Read more...} */ readonly type: "picture-marker"; /** * The URL to an image or SVG document. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#url Read more...} */ url: string | nullish; /** * PictureMarkerSymbol renders {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} graphics in either a * 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} using an image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html Read more...} */ constructor(properties?: PictureMarkerSymbolProperties); /** * The height of the image in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#height Read more...} */ get height(): number; set height(value: number | string); /** * The width of the image in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#width Read more...} */ get width(): number; set width(value: number | string); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#clone Read more...} */ clone(): PictureMarkerSymbol; static fromJSON(json: any): PictureMarkerSymbol; } interface PictureMarkerSymbolProperties extends MarkerSymbolProperties { /** * The height of the image in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#height Read more...} */ height?: number | string; /** * The URL to an image or SVG document. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#url Read more...} */ url?: string | nullish; /** * The width of the image in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PictureMarkerSymbol.html#width Read more...} */ width?: number | string; } export class PointSymbol3D extends Symbol3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#type Read more...} */ readonly type: "point-3d"; /** * PointSymbol3D is used to render features with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} geometry * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html Read more...} */ constructor(properties?: PointSymbol3DProperties); /** * Settings for adding a callout visualization to the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#callout Read more...} */ get callout(): LineCallout3D | nullish; set callout(value: (LineCallout3DProperties & { type: "line" }) | nullish); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection; set symbolLayers(value: CollectionProperties< | (IconSymbol3DLayerProperties & { type: "icon" }) | (ObjectSymbol3DLayerProperties & { type: "object" }) | (TextSymbol3DLayerProperties & { type: "text" }) >); /** * Shifts the symbol along the vertical world axis by a given height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#verticalOffset Read more...} */ get verticalOffset(): Symbol3DVerticalOffset | nullish; set verticalOffset(value: Symbol3DVerticalOffsetProperties | nullish); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#clone Read more...} */ clone(): PointSymbol3D; static fromJSON(json: any): PointSymbol3D; } interface PointSymbol3DProperties extends Symbol3DProperties { /** * Settings for adding a callout visualization to the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#callout Read more...} */ callout?: (LineCallout3DProperties & { type: "line" }) | nullish; /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#symbolLayers Read more...} */ symbolLayers?: CollectionProperties< | (IconSymbol3DLayerProperties & { type: "icon" }) | (ObjectSymbol3DLayerProperties & { type: "object" }) | (TextSymbol3DLayerProperties & { type: "text" }) >; /** * Shifts the symbol along the vertical world axis by a given height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html#verticalOffset Read more...} */ verticalOffset?: Symbol3DVerticalOffsetProperties | nullish; } export class PolygonSymbol3D extends Symbol3D { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html#type Read more...} */ readonly type: "polygon-3d"; /** * PolygonSymbol3D is used to render features with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} geometry * in a 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html Read more...} */ constructor(properties?: PolygonSymbol3DProperties); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection< | ExtrudeSymbol3DLayer | FillSymbol3DLayer | IconSymbol3DLayer | LineSymbol3DLayer | ObjectSymbol3DLayer | TextSymbol3DLayer | WaterSymbol3DLayer >; set symbolLayers(value: CollectionProperties< | (ExtrudeSymbol3DLayerProperties & { type: "extrude" }) | (FillSymbol3DLayerProperties & { type: "fill" }) | (IconSymbol3DLayerProperties & { type: "icon" }) | (LineSymbol3DLayerProperties & { type: "line" }) | (ObjectSymbol3DLayerProperties & { type: "object" }) | (TextSymbol3DLayerProperties & { type: "text" }) | (WaterSymbol3DLayerProperties & { type: "water" }) >); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html#clone Read more...} */ clone(): PolygonSymbol3D; static fromJSON(json: any): PolygonSymbol3D; } interface PolygonSymbol3DProperties extends Symbol3DProperties { /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects * used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html#symbolLayers Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#style Read more...} */ style: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#type Read more...} */ readonly type: "simple-fill"; /** * SimpleFillSymbol is used for rendering 2D polygons in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} * or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html Read more...} */ constructor(properties?: SimpleFillSymbolProperties); /** * The color of the symbol. * * @default [0, 0, 0, 0.25] - black, semitransparent * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#clone Read more...} */ clone(): SimpleFillSymbol; static fromJSON(json: any): SimpleFillSymbol; } interface SimpleFillSymbolProperties extends FillSymbolProperties { /** * The color of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#color Read more...} */ color?: ColorProperties; /** * The fill style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html#style Read more...} */ style?: | "backward-diagonal" | "cross" | "diagonal-cross" | "forward-diagonal" | "horizontal" | "none" | "solid" | "vertical"; } export class SimpleLineSymbol extends LineSymbol { /** * Specifies the cap style. * * @default "round" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#cap Read more...} */ cap: "butt" | "round" | "square"; /** * Specifies the join style. * * @default "round" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#join Read more...} */ join: "miter" | "round" | "bevel"; /** * Maximum allowed ratio of the width of a miter join to the line width. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#miterLimit Read more...} */ miterLimit: number; /** * Specifies the line style. * * @default "solid" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#style Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html polyline geometries} * in a 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html Read more...} */ constructor(properties?: SimpleLineSymbolProperties); /** * Specifies the color, style, and placement of a symbol marker on the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#marker Read more...} */ get marker(): LineSymbolMarker | nullish; set marker(value: (LineSymbolMarkerProperties & { type?: "line-marker" }) | nullish); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#clone Read more...} */ clone(): SimpleLineSymbol; static fromJSON(json: any): SimpleLineSymbol; } interface SimpleLineSymbolProperties extends LineSymbolProperties { /** * Specifies the cap style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#cap Read more...} */ cap?: "butt" | "round" | "square"; /** * Specifies the join style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#join Read more...} */ join?: "miter" | "round" | "bevel"; /** * Specifies the color, style, and placement of a symbol marker on the line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#marker Read more...} */ marker?: (LineSymbolMarkerProperties & { type?: "line-marker" }) | nullish; /** * Maximum allowed ratio of the width of a miter join to the line width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#miterLimit Read more...} */ miterLimit?: number; /** * Specifies the line style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html#style Read more...} */ 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 SVG path of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#path Read more...} */ path: string; /** * The marker style. * * @default "circle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#style Read more...} */ style: "circle" | "square" | "cross" | "x" | "diamond" | "triangle" | "path"; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#type Read more...} */ readonly type: "simple-marker"; /** * SimpleMarkerSymbol is used for rendering 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} geometries * with a simple shape and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#color color} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} * or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html Read more...} */ constructor(properties?: SimpleMarkerSymbolProperties); /** * The color of the symbol. * * @default [255, 255, 255, 0.25] - white, semitransparent * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#color Read more...} */ get color(): Color; set color(value: ColorProperties | number[] | string); /** * The outline of the marker symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#outline Read more...} */ get outline(): SimpleLineSymbol; set outline(value: SimpleLineSymbolProperties & { type?: "simple-line" }); /** * The size of the marker in points. * * @default 12 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#clone Read more...} */ clone(): SimpleMarkerSymbol; static fromJSON(json: any): SimpleMarkerSymbol; } interface SimpleMarkerSymbolProperties extends MarkerSymbolProperties { /** * The color of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#color Read more...} */ color?: ColorProperties | number[] | string; /** * The outline of the marker symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#outline Read more...} */ outline?: SimpleLineSymbolProperties & { type?: "simple-line" }; /** * The SVG path of the icon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#path Read more...} */ path?: string; /** * The size of the marker in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#size Read more...} */ size?: number | string; /** * The marker style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html#style Read more...} */ style?: "circle" | "square" | "cross" | "x" | "diamond" | "triangle" | "path"; } /** * Provides utility functions for converting simple symbols and picture symbols to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbols}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimConversionUtils.html Read more...} */ interface cimConversionUtils { /** * Converts a given symbol to a CIMSymbol. * * @param symbol The symbol to convert to a CIMSymbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimConversionUtils.html#convertToCIMSymbol Read more...} */ convertToCIMSymbol(symbol: SimpleMarkerSymbol | SimpleLineSymbol | SimpleFillSymbol | PictureMarkerSymbol | PictureFillSymbol): CIMSymbol; } export const cimConversionUtils: cimConversionUtils; /** * Provides utility functions for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbols}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html Read more...} */ interface cimSymbolUtils { /** * Sets the color of the symbol layers of a CIMSymbol to a given value if the symbol layer is not color locked. * * @param symbol The CIMSymbol to set the color on. * @param color The desired color value for the symbol. * @param options _Since 4.23_ The options for setting the color of the CIMSymbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#applyCIMSymbolColor Read more...} */ applyCIMSymbolColor(symbol: CIMSymbol, color: Color, options?: cimSymbolUtilsApplyCIMSymbolColorOptions): void; /** * Sets the rotation value of a CIMSymbol. * * @param symbol The CIMSymbol to set the rotation on. * @param rotation The desired rotation of the symbol in degrees. * @param clockwise Indicates whether to rotate the symbol clockwise. Default is `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#applyCIMSymbolRotation Read more...} */ applyCIMSymbolRotation(symbol: CIMSymbol, rotation: number, clockwise?: boolean): void; /** * Returns the first color of the symbol layers in a CIMSymbol. * * @param symbol The CIMSymbol from which to get the color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#getCIMSymbolColor Read more...} */ getCIMSymbolColor(symbol: CIMSymbol): Color | nullish; /** * Returns the rotation value of a CIMSymbol. * * @param symbol The CIMSymbol from which to get the rotation. * @param clockwise Indicates whether to get the rotation value as clockwise rotation. Default is `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#getCIMSymbolRotation Read more...} */ getCIMSymbolRotation(symbol: CIMSymbol, clockwise?: boolean): number; /** * Returns the size of a given CIMSymbol. * * @param symbol The CIMSymbol from which to get the size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#getCIMSymbolSize Read more...} */ getCIMSymbolSize(symbol: CIMSymbol): number; /** * Scales the largest layer of a CIMSymbol to a given size. * * @param symbol The CIMSymbol to scale. * @param size The desired size for the symbol. * @param options Options for scaling the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-cimSymbolUtils.html#scaleCIMSymbolTo Read more...} */ scaleCIMSymbolTo(symbol: CIMSymbol | nullish, size: number, options?: cimSymbolUtilsScaleCIMSymbolToOptions): void; } export const cimSymbolUtils: cimSymbolUtils; export interface cimSymbolUtilsApplyCIMSymbolColorOptions { layersToColor?: "fill" | "outline" | "fill-and-outline"; } export interface cimSymbolUtilsScaleCIMSymbolToOptions { preserveOutlineWidth?: boolean; } /** * Provides a utility method used to deserialize a JSON symbol object returned by the REST API. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-jsonUtils.html Read more...} */ interface symbolsSupportJsonUtils { /** * Creates a new instance of an appropriate {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Symbol} class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/symbol-objects.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-jsonUtils.html#fromJSON Read more...} */ fromJSON(json: any): SymbolUnion; } export const symbolsSupportJsonUtils: symbolsSupportJsonUtils; export class StyleOrigin extends Accessor { /** * Name of the symbol in the style referenced by styleName or styleUrl. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#name Read more...} */ name: string | nullish; /** * The well-known geoscene-provided style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#styleName Read more...} */ styleName: string | nullish; /** * A url to a style definition. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#styleUrl Read more...} */ styleUrl: string | nullish; /** * The style origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html Read more...} */ constructor(properties?: StyleOriginProperties); /** * The portal of the style origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#portal Read more...} */ get portal(): Portal | nullish; set portal(value: PortalProperties | nullish); /** * Creates a deep clone of the style origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#clone Read more...} */ clone(): StyleOrigin; } interface StyleOriginProperties { /** * Name of the symbol in the style referenced by styleName or styleUrl. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#name Read more...} */ name?: string | nullish; /** * The portal of the style origin. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#portal Read more...} */ portal?: PortalProperties | nullish; /** * The well-known geoscene-provided style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#styleName Read more...} */ styleName?: string | nullish; /** * A url to a style definition. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-StyleOrigin.html#styleUrl Read more...} */ styleUrl?: string | nullish; } export class Symbol3DVerticalOffset extends Accessor { /** * The maximum vertical symbol offset in world units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#maxWorldLength Read more...} */ maxWorldLength: number | nullish; /** * The minimum vertical symbol offset in world units. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#minWorldLength Read more...} */ minWorldLength: number; /** * Shifts a symbol along the vertical world axis by a given height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html Read more...} */ constructor(properties?: Symbol3DVerticalOffsetProperties); /** * Vertical symbol offset in screen size. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#screenLength Read more...} */ get screenLength(): number; set screenLength(value: number | string); /** * Creates a deep clone of the vertical offset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#clone Read more...} */ clone(): Symbol3DVerticalOffset; } interface Symbol3DVerticalOffsetProperties { /** * The maximum vertical symbol offset in world units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#maxWorldLength Read more...} */ maxWorldLength?: number | nullish; /** * The minimum vertical symbol offset in world units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#minWorldLength Read more...} */ minWorldLength?: number; /** * Vertical symbol offset in screen size. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-Symbol3DVerticalOffset.html#screenLength Read more...} */ screenLength?: number | string; } /** * Utilities for generating small preview images of symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html Read more...} */ interface symbolUtils { /** * Returns a color representing the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphic's} symbol. * * @param graphic The graphic from which to retrieve the displayed color. This commonly comes from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} or layer view query operation. * @param options Options for generating the display color of the input graphic. These must be specified if the input graphic comes from a layer with a renderer that has {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#visualVariables visual variables} applied. See the object specification below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#getDisplayedColor Read more...} */ getDisplayedColor(graphic: Graphic, options?: symbolUtilsGetDisplayedColorOptions | null): Promise; /** * Returns a symbol representing the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic}. * * @param graphic The graphic from which to retrieve the displayed symbol. This commonly comes from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} operation. * @param options Options for generating the display symbol of the input graphic. These must be specified if the input graphic comes from a layer with a renderer that has {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#visualVariables visual variables} applied. See the object specification below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#getDisplayedSymbol Read more...} */ getDisplayedSymbol(graphic: Graphic, options?: symbolUtilsGetDisplayedSymbolOptions | null): Promise; /** * Returns a label corresponding to the symbol of the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} as displayed in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend}. * * @param graphic The graphic from which to retrieve its associated label as displayed in the legend widget. This commonly comes from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} operation. * @param view The graphic from which to retrieve the displayed symbol. This commonly comes from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} operation. * @param options Options for generating the legend label of the input graphic. These must be specified if the input graphic comes from a layer with a renderer that has {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-SimpleRenderer.html#visualVariables visual variables} applied. See the object specification below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#getLegendLabel Read more...} */ getLegendLabel(graphic: Graphic, view?: MapView | SceneView, options?: symbolUtilsGetLegendLabelOptions | null): Promise; /** * Generates a preview image of a color ramp to display in a DOM element. * * @param colors An array of colors from which to construct the color ramp. * @param options Formatting options for the color ramp. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#renderColorRampPreviewHTML Read more...} */ renderColorRampPreviewHTML(colors: Color[], options?: symbolUtilsRenderColorRampPreviewHTMLOptions): HTMLElement; /** * Generates an HTML element representing the legend of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-PieChartRenderer.html PieChartRenderer}. * * @param colors A list of colors used to render the pie chart. * @param options Options for creating the legend element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#renderPieChartPreviewHTML Read more...} */ renderPieChartPreviewHTML(colors: Color[], options?: symbolUtilsRenderPieChartPreviewHTMLOptions): HTMLElement | nullish; /** * Generates a preview image of a given symbol that can be displayed in * a DOM element. * * @param symbol The symbol for which to generate a preview image. * @param options Formatting options for the symbol preview image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#renderPreviewHTML Read more...} */ renderPreviewHTML(symbol: SymbolUnion, options?: symbolUtilsRenderPreviewHTMLOptions): Promise; /** * Generates an HTML element representing the square or diamond legend element of a relationship renderer. * * @param renderer A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-relationship.html relationship} renderer instance. * @param options Options for creating the legend element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-support-symbolUtils.html#renderRelationshipRampPreviewHTML Read more...} */ renderRelationshipRampPreviewHTML(renderer: UniqueValueRenderer, options?: symbolUtilsRenderRelationshipRampPreviewHTMLOptions): HTMLElement | nullish; } export const symbolUtils: symbolUtils; export interface symbolUtilsGetDisplayedColorOptions { scale?: number; viewingMode?: string; spatialReference?: SpatialReference; renderer?: RendererUnion; resolution?: number; webStyleAcceptedFormats?: ("web" | "cim")[]; } export interface symbolUtilsGetDisplayedSymbolOptions { scale?: number; viewingMode?: string; spatialReference?: SpatialReference; renderer?: RendererUnion; resolution?: number; webStyleAcceptedFormats?: ("web" | "cim")[]; } export interface symbolUtilsGetLegendLabelOptions { scale?: number; viewingMode?: string; spatialReference?: SpatialReference; renderer?: RendererUnion; resolution?: number; } export interface symbolUtilsRenderColorRampPreviewHTMLOptions { align?: "horizontal" | "vertical"; gradient?: boolean; width?: number; height?: number; } export interface symbolUtilsRenderPieChartPreviewHTMLOptions { radius?: number; holePercentage?: number; values?: number[]; outline?: SimpleLineSymbol; } export interface symbolUtilsRenderPreviewHTMLOptions { node?: HTMLElement; size?: number | symbolUtilsRenderPreviewHTMLOptionsSize; maxSize?: number; opacity?: number; scale?: boolean; disableUpsampling?: boolean; symbolConfig?: "tall" | symbolUtilsRenderPreviewHTMLOptionsSymbolConfig; rotation?: number; overrideText?: string; } export interface symbolUtilsRenderPreviewHTMLOptionsSize { width: number; height: number; } export interface symbolUtilsRenderPreviewHTMLOptionsSymbolConfig { isTall?: boolean; isSquareFill?: boolean; } export interface symbolUtilsRenderRelationshipRampPreviewHTMLOptions { node?: HTMLElement; opacity?: number; } export interface Symbol extends Accessor, JSONSupport { } export class Symbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html Read more...} */ constructor(properties?: SymbolProperties); /** * The color of the symbol. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Symbol; } interface SymbolProperties { /** * The color of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html#color Read more...} */ color?: ColorProperties | nullish; } export class Symbol3D extends Symbol { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html#type Read more...} */ readonly type: "point-3d" | "line-3d" | "polygon-3d" | "mesh-3d" | "label-3d"; /** * Symbol3D is the base class for all 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html Read more...} */ constructor(properties?: Symbol3DProperties); /** * The origin of the style from which the symbol was originally referenced. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html#styleOrigin Read more...} */ get styleOrigin(): StyleOrigin | nullish; set styleOrigin(value: StyleOriginProperties | nullish); /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html#symbolLayers Read more...} */ get symbolLayers(): Collection; set symbolLayers(value: CollectionProperties); static fromJSON(json: any): Symbol3D; } interface Symbol3DProperties extends SymbolProperties { /** * The origin of the style from which the symbol was originally referenced. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html#styleOrigin Read more...} */ styleOrigin?: StyleOriginProperties | nullish; /** * A Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Symbol3DLayer} objects used to visualize the graphic or feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html#symbolLayers Read more...} */ symbolLayers?: CollectionProperties; } export interface Symbol3DLayer extends Accessor, JSONSupport { } export class Symbol3DLayer { /** * The 3D symbol layer type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html#type Read more...} */ readonly type: "icon" | "object" | "line" | "path" | "fill" | "water" | "extrude" | "text" | nullish; /** * Symbol layers are used to define the visualization of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon}, and mesh * geometries rendered with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3D.html 3D symbols}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html Read more...} */ constructor(properties?: Symbol3DLayerProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol3DLayer.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Symbol3DLayer; } interface Symbol3DLayerProperties { } export class TextSymbol extends Symbol { /** * The angle of the text. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#angle Read more...} */ angle: number; /** * The border size or width of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#borderLineSize Read more...} */ borderLineSize: number | nullish; /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#horizontalAlignment Read more...} */ horizontalAlignment: "left" | "right" | "center"; /** * Determines whether to adjust the spacing between characters in the text string. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#kerning Read more...} */ kerning: boolean; /** * The height of the space between each line of text. * * @default 1.0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#lineHeight Read more...} */ lineHeight: number; /** * Determines whether every character in the text string is rotated. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#rotated Read more...} */ rotated: boolean; /** * The text string to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#text Read more...} */ text: string; readonly type: "text"; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#verticalAlignment Read more...} */ verticalAlignment: "baseline" | "top" | "middle" | "bottom"; /** * Text symbols are used to define the graphic for displaying labels on * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Sublayer.html Sublayer}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html StreamLayer} in a 2D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html Read more...} */ constructor(properties?: TextSymbolProperties); /** * The background color of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#backgroundColor Read more...} */ get backgroundColor(): Color | nullish; set backgroundColor(value: ColorProperties | nullish); /** * The border color of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#borderLineColor Read more...} */ get borderLineColor(): Color | nullish; set borderLineColor(value: ColorProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html Font} used to style the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#font Read more...} */ get font(): Font; set font(value: FontProperties); /** * The color of the text symbol's halo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#haloColor Read more...} */ get haloColor(): Color | nullish; set haloColor(value: ColorProperties | nullish | number[] | string); /** * The size in points of the text symbol's halo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#haloSize Read more...} */ get haloSize(): number | nullish; set haloSize(value: number | nullish | string); /** * The maximum length in points for each line of text. * * @default 192 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#lineWidth Read more...} */ get lineWidth(): number; set lineWidth(value: number | string); /** * The offset on the x-axis in points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#xoffset Read more...} */ get xoffset(): number; set xoffset(value: number | string); /** * The offset on the y-axis in points. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#yoffset Read more...} */ get yoffset(): number; set yoffset(value: number | string); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#clone Read more...} */ clone(): TextSymbol; static fromJSON(json: any): TextSymbol; } interface TextSymbolProperties extends SymbolProperties { /** * The angle of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#angle Read more...} */ angle?: number; /** * The background color of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#backgroundColor Read more...} */ backgroundColor?: ColorProperties | nullish; /** * The border color of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#borderLineColor Read more...} */ borderLineColor?: ColorProperties | nullish; /** * The border size or width of the label's bounding box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#borderLineSize Read more...} */ borderLineSize?: number | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Font.html Font} used to style the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#font Read more...} */ font?: FontProperties; /** * The color of the text symbol's halo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#haloColor Read more...} */ haloColor?: ColorProperties | nullish | number[] | string; /** * The size in points of the text symbol's halo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#haloSize Read more...} */ haloSize?: number | nullish | string; /** * Adjusts the horizontal alignment of the text in multi-lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#horizontalAlignment Read more...} */ horizontalAlignment?: "left" | "right" | "center"; /** * Determines whether to adjust the spacing between characters in the text string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#kerning Read more...} */ kerning?: boolean; /** * The height of the space between each line of text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#lineHeight Read more...} */ lineHeight?: number; /** * The maximum length in points for each line of text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#lineWidth Read more...} */ lineWidth?: number | string; /** * Determines whether every character in the text string is rotated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#rotated Read more...} */ rotated?: boolean; /** * The text string to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#text Read more...} */ text?: string; /** * Adjusts the vertical alignment of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#verticalAlignment Read more...} */ verticalAlignment?: "baseline" | "top" | "middle" | "bottom"; /** * The offset on the x-axis in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#xoffset Read more...} */ xoffset?: number | string; /** * The offset on the y-axis in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html#yoffset Read more...} */ yoffset?: number | string; } export class TextSymbol3DLayer extends Symbol3DLayer { /** * Adjusts the horizontal alignment of the text in multi-lines. * * @default "center" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#horizontalAlignment Read more...} */ horizontalAlignment: "left" | "right" | "center"; /** * The height of the space between each line of text. * * @default 1.0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#lineHeight Read more...} */ lineHeight: number; /** * The text to be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#text Read more...} */ text: string | nullish; /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#type Read more...} */ readonly type: "text"; /** * Adjusts the vertical alignment of the text. * * @default "baseline" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#verticalAlignment Read more...} */ verticalAlignment: "baseline" | "top" | "middle" | "bottom"; /** * TextSymbol3DLayer is used to draw text labels for features of any geometry type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html Read more...} */ constructor(properties?: TextSymbol3DLayerProperties); /** * The background of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#background Read more...} */ get background(): TextSymbol3DLayerBackground | nullish; set background(value: TextSymbol3DLayerBackgroundProperties | nullish); /** * The font of the text label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#font Read more...} */ get font(): Font | nullish; set font(value: FontProperties | nullish); /** * The halo surrounding the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#halo Read more...} */ get halo(): TextSymbol3DLayerHalo | nullish; set halo(value: TextSymbol3DLayerHaloProperties | nullish); /** * The material used to color the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#material Read more...} */ get material(): TextSymbol3DLayerMaterial | nullish; set material(value: TextSymbol3DLayerMaterialProperties | nullish); /** * Size of the text label in points. * * @default 9 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#size Read more...} */ get size(): number; set size(value: number | string); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#clone Read more...} */ clone(): TextSymbol3DLayer; static fromJSON(json: any): TextSymbol3DLayer; } interface TextSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The background of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#background Read more...} */ background?: TextSymbol3DLayerBackgroundProperties | nullish; /** * The font of the text label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#font Read more...} */ font?: FontProperties | nullish; /** * The halo surrounding the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#halo Read more...} */ halo?: TextSymbol3DLayerHaloProperties | nullish; /** * Adjusts the horizontal alignment of the text in multi-lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#horizontalAlignment Read more...} */ horizontalAlignment?: "left" | "right" | "center"; /** * The height of the space between each line of text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#lineHeight Read more...} */ lineHeight?: number; /** * The material used to color the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#material Read more...} */ material?: TextSymbol3DLayerMaterialProperties | nullish; /** * Size of the text label in points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#size Read more...} */ size?: number | string; /** * The text to be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#text Read more...} */ text?: string | nullish; /** * Adjusts the vertical alignment of the text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol3DLayer.html#verticalAlignment Read more...} */ verticalAlignment?: "baseline" | "top" | "middle" | "bottom"; } export interface TextSymbol3DLayerBackgroundProperties { color?: ColorProperties | nullish; } export interface TextSymbol3DLayerBackground extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export interface TextSymbol3DLayerHaloProperties { color?: ColorProperties | nullish; size?: number | string; } export interface TextSymbol3DLayerHalo extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); get size(): number; set size(value: number | string); } export interface TextSymbol3DLayerMaterialProperties { color?: ColorProperties | nullish; } export interface TextSymbol3DLayerMaterial extends AnonymousAccessor { get color(): Color | nullish; set color(value: ColorProperties | nullish); } export class WaterSymbol3DLayer extends Symbol3DLayer { /** * The symbol type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#type Read more...} */ readonly type: "water"; /** * Indicates the size of the waterbody which is represented by the * symbol layer. * * @default "medium" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waterbodySize Read more...} */ waterbodySize: "small" | "medium" | "large"; /** * Indicates the direction in which the waves travel. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waveDirection Read more...} */ waveDirection: number | nullish; /** * Indicates the shape and intensity of the waves. * * @default "moderate" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waveStrength Read more...} */ waveStrength: "calm" | "rippled" | "slight" | "moderate"; /** * WaterSymbol3DLayer is used to render {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} geometries as realistic, animated water surfaces, * therefore it can only be used inside a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html PolygonSymbol3D}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html Read more...} */ constructor(properties?: WaterSymbol3DLayerProperties); /** * The dominant color used to shade the water. * * @default "#0077be" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#color Read more...} */ get color(): Color | nullish; set color(value: ColorProperties | nullish); /** * Creates a deep clone of the symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#clone Read more...} */ clone(): WaterSymbol3DLayer; static fromJSON(json: any): WaterSymbol3DLayer; } interface WaterSymbol3DLayerProperties extends Symbol3DLayerProperties { /** * The dominant color used to shade the water. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#color Read more...} */ color?: ColorProperties | nullish; /** * Indicates the size of the waterbody which is represented by the * symbol layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waterbodySize Read more...} */ waterbodySize?: "small" | "medium" | "large"; /** * Indicates the direction in which the waves travel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waveDirection Read more...} */ waveDirection?: number | nullish; /** * Indicates the shape and intensity of the waves. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WaterSymbol3DLayer.html#waveStrength Read more...} */ waveStrength?: "calm" | "rippled" | "slight" | "moderate"; } export class WebStyleSymbol extends Symbol { /** * The name of the symbol within the web style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#name Read more...} */ name: string | nullish; /** * A registered web style name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#styleName Read more...} */ styleName: string | nullish; /** * URL that points to the web style definition. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#styleUrl Read more...} */ styleUrl: string | nullish; readonly type: "web-style"; /** * WebStyleSymbol is a class used to conveniently create vector 2D symbols and realistic and thematic * 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html Read more...} */ constructor(properties?: WebStyleSymbolProperties); /** * The portal that contains the web style this symbol refers to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#portal Read more...} */ get portal(): Portal | nullish; set portal(value: PortalProperties | nullish); /** * Creates a deep clone of the symbol. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#clone Read more...} */ clone(): WebStyleSymbol; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} instance the WebStyleSymbol refers to. * * @param options An object with the following properties. * @deprecated since version 4.33. Use [`fetchSymbol`](#fetchSymbol) instead. Pass `{ acceptedFormats: ["cim"] }` * as options to [`fetchSymbol`](#fetchSymbol) to retrieve only CIM symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#fetchCIMSymbol Read more...} */ fetchCIMSymbol(options?: WebStyleSymbolFetchCIMSymbolOptions | null): Promise; /** * Resolves and returns the symbol instance the WebStyleSymbol refers to. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#fetchSymbol Read more...} */ fetchSymbol(options?: WebStyleSymbolFetchSymbolOptions | null): Promise; static fromJSON(json: any): WebStyleSymbol; } interface WebStyleSymbolProperties extends SymbolProperties { /** * The name of the symbol within the web style. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#name Read more...} */ name?: string | nullish; /** * The portal that contains the web style this symbol refers to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#portal Read more...} */ portal?: PortalProperties | nullish; /** * A registered web style name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#styleName Read more...} */ styleName?: string | nullish; /** * URL that points to the web style definition. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html#styleUrl Read more...} */ styleUrl?: string | nullish; } export interface WebStyleSymbolFetchCIMSymbolOptions { signal?: AbortSignal | nullish; } export interface WebStyleSymbolFetchSymbolOptions { acceptedFormats?: ("web" | "cim")[]; signal?: AbortSignal | nullish; } /** * CIMSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/CIMSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#CIMSymbol Read more...} */ export type symbolsCIMSymbol = CIMSymbol; /** * ExtrudeSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/ExtrudeSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#ExtrudeSymbol3DLayer Read more...} */ export type symbolsExtrudeSymbol3DLayer = ExtrudeSymbol3DLayer; /** * FillSymbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~FillSymbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#FillSymbol Read more...} */ export type symbolsFillSymbol = PictureFillSymbol | SimpleFillSymbol; /** * FillSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/FillSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#FillSymbol3DLayer Read more...} */ export type symbolsFillSymbol3DLayer = FillSymbol3DLayer; /** * Font. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/Font} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Font Read more...} */ export type symbolsFont = Font; /** * IconSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/IconSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#IconSymbol3DLayer Read more...} */ export type symbolsIconSymbol3DLayer = IconSymbol3DLayer; /** * LabelSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LabelSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LabelSymbol3D Read more...} */ export type symbolsLabelSymbol3D = LabelSymbol3D; /** * LineSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LineSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LineSymbol3D Read more...} */ export type symbolsLineSymbol3D = LineSymbol3D; /** * LineSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/LineSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#LineSymbol3DLayer Read more...} */ export type symbolsLineSymbol3DLayer = LineSymbol3DLayer; /** * MarkerSymbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~MarkerSymbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#MarkerSymbol Read more...} */ export type symbolsMarkerSymbol = PictureMarkerSymbol | SimpleMarkerSymbol; /** * MeshSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/MeshSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#MeshSymbol3D Read more...} */ export type symbolsMeshSymbol3D = MeshSymbol3D; /** * ObjectSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/ObjectSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#ObjectSymbol3DLayer Read more...} */ export type symbolsObjectSymbol3DLayer = ObjectSymbol3DLayer; /** * PathSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PathSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PathSymbol3DLayer Read more...} */ export type symbolsPathSymbol3DLayer = PathSymbol3DLayer; /** * PictureFillSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PictureFillSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PictureFillSymbol Read more...} */ export type symbolsPictureFillSymbol = PictureFillSymbol; /** * PictureMarkerSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PictureMarkerSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PictureMarkerSymbol Read more...} */ export type symbolsPictureMarkerSymbol = PictureMarkerSymbol; /** * PointSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PointSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PointSymbol3D Read more...} */ export type symbolsPointSymbol3D = PointSymbol3D; /** * PolygonSymbol3D. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/PolygonSymbol3D} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#PolygonSymbol3D Read more...} */ export type symbolsPolygonSymbol3D = PolygonSymbol3D; /** * SimpleFillSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleFillSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleFillSymbol Read more...} */ export type symbolsSimpleFillSymbol = SimpleFillSymbol; /** * SimpleLineSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleLineSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleLineSymbol Read more...} */ export type symbolsSimpleLineSymbol = SimpleLineSymbol; /** * SimpleMarkerSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/SimpleMarkerSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#SimpleMarkerSymbol Read more...} */ export type symbolsSimpleMarkerSymbol = SimpleMarkerSymbol; /** * Symbol types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~SymbolUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol Read more...} */ export type symbolsSymbol = Symbol2D3D | WebStyleSymbol; /** * Symbol2D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol2DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol2D Read more...} */ export type Symbol2D = | PictureFillSymbol | PictureMarkerSymbol | SimpleFillSymbol | SimpleLineSymbol | SimpleMarkerSymbol | TextSymbol | CIMSymbol; /** * Symbol2D3D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol2D3DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol2D3D Read more...} */ export type Symbol2D3D = Symbol2D | symbolsSymbol3D; /** * Symbol3D types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol3DUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol3D Read more...} */ export type symbolsSymbol3D = LabelSymbol3D | LineSymbol3D | MeshSymbol3D | PointSymbol3D | PolygonSymbol3D; /** * Symbol3DLayer types. * * @deprecated since version 4.32. Use {@link module:geoscene/unionTypes~Symbol3DLayerUnion} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#Symbol3DLayer Read more...} */ export type symbolsSymbol3DLayer = | ExtrudeSymbol3DLayer | FillSymbol3DLayer | WaterSymbol3DLayer | IconSymbol3DLayer | LineSymbol3DLayer | ObjectSymbol3DLayer | PathSymbol3DLayer | TextSymbol3DLayer; /** * TextSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/TextSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#TextSymbol Read more...} */ export type symbolsTextSymbol = TextSymbol; /** * TextSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/TextSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#TextSymbol3DLayer Read more...} */ export type symbolsTextSymbol3DLayer = TextSymbol3DLayer; /** * WaterSymbol3DLayer. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/WaterSymbol3DLayer} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#WaterSymbol3DLayer Read more...} */ export type symbolsWaterSymbol3DLayer = WaterSymbol3DLayer; /** * WebStyleSymbol. * * @deprecated since version 4.32. Import {@link module:geoscene/symbols/WebStyleSymbol} directly instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols.html#WebStyleSymbol Read more...} */ export type symbolsWebStyleSymbol = WebStyleSymbol; export interface AttributeTableTemplate extends Accessor, JSONSupport { } export class AttributeTableTemplate { /** * An `AttributeTableTemplate` manages the configuration of how the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget displays its columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html Read more...} */ constructor(properties?: AttributeTableTemplateProperties); /** * An array of attribute table element * objects that represent an ordered list of table elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#elements Read more...} */ get elements(): | ( | AttributeTableAttachmentElement | AttributeTableFieldElement | AttributeTableGroupElement | AttributeTableRelationshipElement )[] | nullish; set elements(value: | ( | (AttributeTableAttachmentElementProperties & { type: "attachment" }) | (AttributeTableFieldElementProperties & { type: "field" }) | (AttributeTableGroupElementProperties & { type: "group" }) | (AttributeTableRelationshipElementProperties & { type: "relationship" }) )[] | nullish); /** * An Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#FieldOrder FieldOrder} objects indicating the records' sort order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#orderByFields Read more...} */ get orderByFields(): FieldOrder[] | nullish; set orderByFields(value: FieldOrderProperties[] | nullish); /** * Creates a deep clone of the AttributeTableTemplate class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#clone Read more...} */ clone(): AttributeTableTemplate; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeTableTemplate; } interface AttributeTableTemplateProperties { /** * An array of attribute table element * objects that represent an ordered list of table elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#elements Read more...} */ elements?: | ( | (AttributeTableAttachmentElementProperties & { type: "attachment" }) | (AttributeTableFieldElementProperties & { type: "field" }) | (AttributeTableGroupElementProperties & { type: "group" }) | (AttributeTableRelationshipElementProperties & { type: "relationship" }) )[] | nullish; /** * An Array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#FieldOrder FieldOrder} objects indicating the records' sort order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#orderByFields Read more...} */ orderByFields?: FieldOrderProperties[] | nullish; } /** * This object sets a field and sort order for how records display within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#FieldOrder Read more...} */ export interface FieldOrderProperties { field?: string | nullish; order?: "asc" | "desc" | nullish; } /** * This object sets a field and sort order for how records display within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#FieldOrder Read more...} */ export interface FieldOrder extends AnonymousAccessor { field: string | nullish; order: "asc" | "desc" | nullish; } /** * A convenience module for importing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html AttributeTableElement} classes * when developing with {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html Read more...} */ namespace tablesElements { /** * Attribute table element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableElement Read more...} */ export type AttributeTableElement = | __geoscene.AttributeTableFieldElement | __geoscene.AttributeTableGroupElement | __geoscene.AttributeTableRelationshipElement | __geoscene.AttributeTableAttachmentElement; /** * `AttributeTableFieldElement` defines how a feature layer's field participates in the attribute table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableFieldElement Read more...} */ export type AttributeTableFieldElement = __geoscene.AttributeTableFieldElement; export const AttributeTableFieldElement: typeof __geoscene.AttributeTableFieldElement; /** * `AttributeTableGroupElement` defines a container that holds a set of attribute table elements * that can be displayed together. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableGroupElement Read more...} */ export type AttributeTableGroupElement = __geoscene.AttributeTableGroupElement; export const AttributeTableGroupElement: typeof __geoscene.AttributeTableGroupElement; /** * `AttributeTableRelationshipElement` defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableRelationshipElement Read more...} */ export type AttributeTableRelationshipElement = __geoscene.AttributeTableRelationshipElement; export const AttributeTableRelationshipElement: typeof __geoscene.AttributeTableRelationshipElement; /** * `AttributeTableAttachmentElement` defines how one or more attachments can participate in the attribute table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableAttachmentElement Read more...} */ export type AttributeTableAttachmentElement = __geoscene.AttributeTableAttachmentElement; export const AttributeTableAttachmentElement: typeof __geoscene.AttributeTableAttachmentElement; } export class AttributeTableAttachmentElement extends AttributeTableElement { /** * The display type of the attachment element in the table. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html#displayType Read more...} */ displayType: "auto"; /** * The type of the attribute table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html#type Read more...} */ readonly type: "attachment"; /** * An `AttributeTableAttachmentElement` defines how attachments display within a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html Read more...} */ constructor(properties?: AttributeTableAttachmentElementProperties); /** * Creates a deep clone of the AttributeTableAttachmentElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html#clone Read more...} */ clone(): AttributeTableAttachmentElement; static fromJSON(json: any): AttributeTableAttachmentElement; } interface AttributeTableAttachmentElementProperties extends AttributeTableElementProperties { /** * The display type of the attachment element in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html#displayType Read more...} */ displayType?: "auto"; } export interface AttributeTableElement extends Accessor, JSONSupport { } export class AttributeTableElement { /** * The table element's description which provides the purpose behind it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#description Read more...} */ description: string | nullish; /** * A string value containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#label Read more...} */ label: string | nullish; /** * The type of table element to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#type Read more...} */ readonly type: "attachment" | "field" | "group" | "relationship"; /** * Attribute table elements define what should display within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html AttributeTableTemplate} elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html Read more...} */ constructor(properties?: AttributeTableElementProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AttributeTableElement; } interface AttributeTableElementProperties { /** * The table element's description which provides the purpose behind it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#description Read more...} */ description?: string | nullish; /** * A string value containing the field alias. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html#label Read more...} */ label?: string | nullish; } export class AttributeTableFieldElement extends AttributeTableElement { /** * The field name as defined by the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html#fieldName Read more...} */ fieldName: string | nullish; /** * Indicates the type of attribute table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html#type Read more...} */ readonly type: "field"; /** * An `AttributeTableFieldElement` table element defines how a layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field} displays in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html Read more...} */ constructor(properties?: AttributeTableFieldElementProperties); /** * Creates a deep clone of the AttributeTableFieldElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html#clone Read more...} */ clone(): AttributeTableFieldElement; static fromJSON(json: any): AttributeTableFieldElement; } interface AttributeTableFieldElementProperties extends AttributeTableElementProperties { /** * The field name as defined by the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html#fieldName Read more...} */ fieldName?: string | nullish; } export class AttributeTableGroupElement extends AttributeTableElement { /** * The type of the attribute table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableGroupElement.html#type Read more...} */ readonly type: "group"; /** * An `AttributeTableGroupElement` table element defines a container that holds a set of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-AttributeTableTemplate.html#elements table elements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableGroupElement.html Read more...} */ constructor(properties?: AttributeTableGroupElementProperties); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html relationship}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html attachment} elements to display as grouped. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableGroupElement.html#elements Read more...} */ get elements(): ( | AttributeTableFieldElement | AttributeTableRelationshipElement | AttributeTableAttachmentElement )[]; set elements(value: ( | (AttributeTableFieldElementProperties & { type: "field" }) | (AttributeTableRelationshipElementProperties & { type: "relationship" }) | (AttributeTableAttachmentElementProperties & { type: "attachment" }) )[]); /** * Creates a deep clone of the AttributeTableGroupElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableGroupElement.html#clone Read more...} */ clone(): AttributeTableGroupElement; static fromJSON(json: any): AttributeTableGroupElement; } interface AttributeTableGroupElementProperties extends AttributeTableElementProperties { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableFieldElement.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html relationship}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableAttachmentElement.html attachment} elements to display as grouped. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableGroupElement.html#elements Read more...} */ elements?: ( | (AttributeTableFieldElementProperties & { type: "field" }) | (AttributeTableRelationshipElementProperties & { type: "relationship" }) | (AttributeTableAttachmentElementProperties & { type: "attachment" }) )[]; } export class AttributeTableRelationshipElement extends AttributeTableElement { /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html#relationshipId Read more...} */ relationshipId: number; /** * Indicates the type of attribute table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableElement.html element}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html#type Read more...} */ readonly type: "relationship"; /** * An `AttributeTableRelationshipElement` element defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates and displays within a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html Read more...} */ constructor(properties?: AttributeTableRelationshipElementProperties); /** * Creates a deep clone of the AttributeTableRelationshipElement class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html#clone Read more...} */ clone(): AttributeTableRelationshipElement; static fromJSON(json: any): AttributeTableRelationshipElement; } interface AttributeTableRelationshipElementProperties extends AttributeTableElementProperties { /** * The numeric id value for the defined relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements-AttributeTableRelationshipElement.html#relationshipId Read more...} */ relationshipId?: number; } /** * `AttributeTableAttachmentElement` defines how one or more attachments can participate in the attribute table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableAttachmentElement Read more...} */ export type elementsAttributeTableAttachmentElement = AttributeTableAttachmentElement; /** * Attribute table element types. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableElement Read more...} */ export type elementsAttributeTableElement = | AttributeTableFieldElement | AttributeTableGroupElement | AttributeTableRelationshipElement | AttributeTableAttachmentElement; /** * `AttributeTableFieldElement` defines how a feature layer's field participates in the attribute table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableFieldElement Read more...} */ export type elementsAttributeTableFieldElement = AttributeTableFieldElement; /** * `AttributeTableGroupElement` defines a container that holds a set of attribute table elements * that can be displayed together. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableGroupElement Read more...} */ export type elementsAttributeTableGroupElement = AttributeTableGroupElement; /** * `AttributeTableRelationshipElement` defines how a relationship between {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature layers} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#tables tables} participates in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-tables-elements.html#AttributeTableRelationshipElement Read more...} */ export type elementsAttributeTableRelationshipElement = AttributeTableRelationshipElement; export interface TimeExtent extends Accessor, JSONSupport { } export class TimeExtent { /** * A period of time with a definitive {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#start start} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#end end} date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html Read more...} */ constructor(properties?: TimeExtentProperties); /** * The end time of the time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#end Read more...} */ get end(): Date | nullish; set end(value: DateProperties | nullish); /** * The start time of the time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#start Read more...} */ get start(): Date | nullish; set start(value: DateProperties | nullish); /** * Creates a deep clone of TimeExtent object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#clone Read more...} */ clone(): TimeExtent; /** * Expands the TimeExtent so that the start and end dates are rounded down and up, respectively, to the parsed time unit. * * @param unit The time unit to align the start and end dates. * @param timeZone The time zone in which progressing will occur. The default is "system". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#expandTo Read more...} */ 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. * * @param timeExtent The time extent to be intersected with the time extent on which `intersection()` is being called on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#intersection Read more...} */ intersection(timeExtent: TimeExtent | nullish): TimeExtent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#toJSON Read more...} */ toJSON(): any; /** * Returns the time extent resulting from the union of the current time extent and a given time extent. * * @param timeExtent The time extent to be unioned with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#union Read more...} */ union(timeExtent: TimeExtent | nullish): TimeExtent; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TimeExtent; } interface TimeExtentProperties { /** * The end time of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#end Read more...} */ end?: DateProperties | nullish; /** * The start time of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html#start Read more...} */ start?: DateProperties | nullish; } export interface TimeInterval extends Accessor, JSONSupport, Clonable { } export class TimeInterval { /** * Temporal units. * * @default "milliseconds" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#unit Read more...} */ unit: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#value Read more...} */ value: number; /** * TimeInterval is a class that describes a length of time in one of ten temporal * units such as seconds, days, or years. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html Read more...} */ constructor(properties?: TimeIntervalProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TimeInterval; } interface TimeIntervalProperties { /** * Temporal units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#unit Read more...} */ unit?: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html#value Read more...} */ value?: number; } export interface geosceneTimeExtent extends Accessor, JSONSupport { } export class geosceneTimeExtent { constructor(properties?: geosceneTimeExtentProperties); /** * The end time of the time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#end Read more...} */ get end(): Date | nullish; set end(value: DateProperties | nullish); /** * The start time of the time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#start Read more...} */ get start(): Date | nullish; set start(value: DateProperties | nullish); /** * Creates a deep clone of TimeExtent object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#clone Read more...} */ clone(): TimeExtent; /** * Expands the TimeExtent so that the start and end dates are rounded down and up, respectively, to the parsed time unit. * * @param unit The time unit to align the start and end dates. * @param timeZone The time zone in which progressing will occur. The default is "system". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#expandTo Read more...} */ 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. * * @param timeExtent The time extent to be intersected with the time extent on which `intersection()` is being called on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#intersection Read more...} */ intersection(timeExtent: TimeExtent): TimeExtent; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#toJSON Read more...} */ toJSON(): any; /** * Returns the time extent resulting from the union of the current time extent and a given time extent. * * @param timeExtent The time extent to be unioned with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#union Read more...} */ union(timeExtent: TimeExtent): TimeExtent; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): geosceneTimeExtent; } interface geosceneTimeExtentProperties { /** * The end time of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#end Read more...} */ end?: DateProperties | nullish; /** * The start time of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeExtent.html#start Read more...} */ start?: DateProperties | nullish; } export interface geosceneTimeInterval extends Accessor, JSONSupport, Clonable { } export class geosceneTimeInterval { /** * Temporal units. * * @default "milliseconds" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#unit Read more...} */ unit: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#value Read more...} */ value: number; constructor(properties?: geosceneTimeIntervalProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): geosceneTimeInterval; } interface geosceneTimeIntervalProperties { /** * Temporal units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#unit Read more...} */ unit?: | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries"; /** * The numerical value of the time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-TimeInterval.html#value Read more...} */ value?: number; } /** * A module for importing union types for use in {@link https://doc.geoscene.cn/javascript/4.33/get-started/#typescript TypeScript}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html Read more...} */ namespace unionTypes { /** * Union of all possible analsysis views that can be created in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#AnalysisViewUnion Read more...} */ export type AnalysisViewUnion = | __geoscene.AreaMeasurementAnalysisView3D | __geoscene.DimensionAnalysisView3D | __geoscene.DirectLineMeasurementAnalysisView3D | __geoscene.LineOfSightAnalysisView3D | __geoscene.SliceAnalysisView3D | __geoscene.ViewshedAnalysisView3D; /** * Union of all possible analysis types that can be added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#AnalysisUnion Read more...} */ export type AnalysisUnion = | __geoscene.AreaMeasurementAnalysis | __geoscene.DimensionAnalysis | __geoscene.DirectLineMeasurementAnalysis | __geoscene.LineOfSightAnalysis | __geoscene.SliceAnalysis | __geoscene.ViewshedAnalysis; /** * Union of renderers with visual variables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RendererWithVisualVariablesUnion Read more...} */ export type RendererWithVisualVariablesUnion = | __geoscene.SimpleRenderer | __geoscene.ClassBreaksRenderer | __geoscene.UniqueValueRenderer | __geoscene.DotDensityRenderer | __geoscene.DictionaryRenderer | __geoscene.PieChartRenderer; /** * Union of renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RendererUnion Read more...} */ export type RendererUnion = __geoscene.HeatmapRenderer | __geoscene.RendererWithVisualVariablesUnion; /** * Union of raster renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RasterRendererUnion Read more...} */ export type RasterRendererUnion = | __geoscene.FlowRenderer | __geoscene.ClassBreaksRenderer | __geoscene.UniqueValueRenderer | __geoscene.RasterColormapRenderer | __geoscene.RasterStretchRenderer | __geoscene.VectorFieldRenderer | __geoscene.RasterShadedReliefRenderer; /** * Union of point cloud renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#PointCloudRendererUnion Read more...} */ export type PointCloudRendererUnion = | __geoscene.PointCloudClassBreaksRenderer | __geoscene.PointCloudRGBRenderer | __geoscene.PointCloudStretchRenderer | __geoscene.PointCloudUniqueValueRenderer; /** * Union of all geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#GeometryUnion Read more...} */ export type GeometryUnion = | __geoscene.Extent | __geoscene.Multipoint | __geoscene.Point | __geoscene.Polygon | __geoscene.Polyline | __geoscene.Mesh; /** * Union of 2D fill symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#FillSymbol2DUnion Read more...} */ export type FillSymbol2DUnion = __geoscene.PictureFillSymbol | __geoscene.SimpleFillSymbol; /** * Union of 2D marker symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#MarkerSymbol2DUnion Read more...} */ export type MarkerSymbol2DUnion = __geoscene.PictureMarkerSymbol | __geoscene.SimpleMarkerSymbol; /** * Union of 2D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol2DUnion Read more...} */ export type Symbol2DUnion = | __geoscene.PictureFillSymbol | __geoscene.PictureMarkerSymbol | __geoscene.SimpleFillSymbol | __geoscene.SimpleLineSymbol | __geoscene.SimpleMarkerSymbol | __geoscene.TextSymbol | __geoscene.CIMSymbol; /** * Union of 3D symbol layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol3DLayerUnion Read more...} */ export type Symbol3DLayerUnion = | __geoscene.ExtrudeSymbol3DLayer | __geoscene.FillSymbol3DLayer | __geoscene.WaterSymbol3DLayer | __geoscene.IconSymbol3DLayer | __geoscene.LineSymbol3DLayer | __geoscene.ObjectSymbol3DLayer | __geoscene.PathSymbol3DLayer | __geoscene.TextSymbol3DLayer; /** * Union of 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol3DUnion Read more...} */ export type Symbol3DUnion = | __geoscene.LabelSymbol3D | __geoscene.LineSymbol3D | __geoscene.MeshSymbol3D | __geoscene.PointSymbol3D | __geoscene.PolygonSymbol3D; /** * Union of 2D and 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol2D3DUnion Read more...} */ export type Symbol2D3DUnion = __geoscene.Symbol2DUnion | __geoscene.Symbol3DUnion; /** * Union of symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#SymbolUnion Read more...} */ export type SymbolUnion = __geoscene.Symbol2D3DUnion | __geoscene.WebStyleSymbol; } /** * Union of all possible analysis types that can be added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#AnalysisUnion Read more...} */ export type AnalysisUnion = | AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis; /** * Union of all possible analsysis views that can be created in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#AnalysisViewUnion Read more...} */ export type AnalysisViewUnion = | AreaMeasurementAnalysisView3D | DimensionAnalysisView3D | DirectLineMeasurementAnalysisView3D | LineOfSightAnalysisView3D | SliceAnalysisView3D | ViewshedAnalysisView3D; /** * Union of 2D fill symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#FillSymbol2DUnion Read more...} */ export type FillSymbol2DUnion = PictureFillSymbol | SimpleFillSymbol; /** * Union of all geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#GeometryUnion Read more...} */ export type GeometryUnion = Extent | Multipoint | Point | Polygon | Polyline | Mesh; /** * Union of 2D marker symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#MarkerSymbol2DUnion Read more...} */ export type MarkerSymbol2DUnion = PictureMarkerSymbol | SimpleMarkerSymbol; /** * Union of point cloud renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#PointCloudRendererUnion Read more...} */ export type PointCloudRendererUnion = | PointCloudClassBreaksRenderer | PointCloudRGBRenderer | PointCloudStretchRenderer | PointCloudUniqueValueRenderer; /** * Union of raster renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RasterRendererUnion Read more...} */ export type RasterRendererUnion = | FlowRenderer | ClassBreaksRenderer | UniqueValueRenderer | RasterColormapRenderer | RasterStretchRenderer | VectorFieldRenderer | RasterShadedReliefRenderer; /** * Union of renderers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RendererUnion Read more...} */ export type RendererUnion = HeatmapRenderer | RendererWithVisualVariablesUnion; /** * Union of renderers with visual variables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#RendererWithVisualVariablesUnion Read more...} */ export type RendererWithVisualVariablesUnion = | SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | DotDensityRenderer | DictionaryRenderer | PieChartRenderer; /** * Union of 2D and 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol2D3DUnion Read more...} */ export type Symbol2D3DUnion = Symbol2DUnion | Symbol3DUnion; /** * Union of 2D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol2DUnion Read more...} */ export type Symbol2DUnion = | PictureFillSymbol | PictureMarkerSymbol | SimpleFillSymbol | SimpleLineSymbol | SimpleMarkerSymbol | TextSymbol | CIMSymbol; /** * Union of 3D symbol layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol3DLayerUnion Read more...} */ export type Symbol3DLayerUnion = | ExtrudeSymbol3DLayer | FillSymbol3DLayer | WaterSymbol3DLayer | IconSymbol3DLayer | LineSymbol3DLayer | ObjectSymbol3DLayer | PathSymbol3DLayer | TextSymbol3DLayer; /** * Union of 3D symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#Symbol3DUnion Read more...} */ export type Symbol3DUnion = LabelSymbol3D | LineSymbol3D | MeshSymbol3D | PointSymbol3D | PolygonSymbol3D; /** * Union of symbols. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-unionTypes.html#SymbolUnion Read more...} */ export type SymbolUnion = Symbol2D3DUnion | WebStyleSymbol; /** * Provides utility methods for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html VersioningStates}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-utils.html Read more...} */ interface versionManagementUtils { /** * Used to create a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html VersioningStates}. * * @param input Input used to to create a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html VersioningStates}. * @param usePersistentReadSessions If set to `true`, the current version will have a read lock. Additionally, when switching versions, the new current version will also have a read lock. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-utils.html#createVersioningStates Read more...} */ createVersioningStates(input: WebMap | VersionAdapter[], usePersistentReadSessions: boolean): Promise>; /** * Used to get a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html VersioningStates} from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * @param view View used to get a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html VersioningStates}. * @param usePersistentReadSessions If set to `true`, the current version will have a read lock. Additionally, when switching versions, the new current version will also have a read lock. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-utils.html#getVersioningStates Read more...} */ getVersioningStates(view: View, usePersistentReadSessions: boolean): Promise>; } export const versionManagementUtils: versionManagementUtils; /** * Provides utility methods for creating {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter VersionAdapters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-versionAdapters-utils.html Read more...} */ interface versionAdaptersUtils { /** * Used to create an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter VersionAdapter}. * * @param input Input used to create an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter VersionAdapter}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-versionAdapters-utils.html#createVersionAdapter Read more...} */ createVersionAdapter(input: Network | FeatureLayer | SubtypeGroupLayer): VersionAdapter | nullish; /** * Used to create an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter VersionAdapters}. * * @param input Input used to create an array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter VersionAdapters}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-versionAdapters-utils.html#createVersionAdapters Read more...} */ createVersionAdapters(input: Network[] | FeatureLayer[] | SubtypeGroupLayer[]): VersionAdapter[]; } export const versionAdaptersUtils: versionAdaptersUtils; export class VersioningState { /** * The current version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#currentVersion Read more...} */ currentVersion: VersionIdentifier | Date; /** * Contains information on the current version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#currentVersionInfo Read more...} */ currentVersionInfo: VersionInfo | nullish; /** * Contains the default version's name and guid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#defaultVersionIdentifier Read more...} */ readonly defaultVersionIdentifier: VersionIdentifier; /** * The absolute URL of the REST endpoint for the feature service housing the version management service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#featureServiceUrl Read more...} */ featureServiceUrl: string; /** * If true, current version is the default version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#isDefault Read more...} */ readonly isDefault: boolean; /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#loadError Read more...} */ readonly loadError: Error | nullish; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#loadStatus Read more...} */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The state of the current version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#state Read more...} */ state: "lock-none" | "lock-read" | "lock-write"; /** * The absolute URL of the REST endpoint for the version management service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#url Read more...} */ url: string; /** * If the set to `true`, the current version will have a read lock. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#usePersistentReadSessions Read more...} */ usePersistentReadSessions: boolean; /** * Contains a collection of all versionable in the versioning state class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#versionableItems Read more...} */ versionableItems: Collection; /** * Contains list of all available versions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#versionInfos Read more...} */ versionInfos: VersionInfo[]; /** * Contains metadata about the version management service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#versionManagementService Read more...} */ versionManagementService: VersionManagementService; constructor(properties?: any); /** * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions. * * @param versionIdentifier Identifier for a version. * @param props Contains properties that will be altered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#alterVersion Read more...} */ alterVersion(versionIdentifier: VersionIdentifier, props: VersioningStateAlterVersionProps): Promise; /** * Method used to change a layer's version/moment or network's version/moment. * * @param toVersion Incoming Version or Date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#changeVersion Read more...} */ changeVersion(toVersion: Date | VersionIdentifier): Promise>; /** * Deletes a version given the following parameters. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#deleteVersion Read more...} */ deleteVersion(versionIdentifier: VersionIdentifier): Promise; /** * Method used to get extended information about a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#getVersionInfoExtended Read more...} */ getVersionInfoExtended(): Promise; /** * Returns all versions accessible to the currently logged-in user. * * @param refresh If refresh is true, a new REST call will be made to the server to get the available versions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#getVersionInfos Read more...} */ getVersionInfos(refresh: boolean): Promise; /** * Triggers the loading of the version management service instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#load Read more...} */ load(): Promise; /** * This method redos the last edit made while in an edit session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#redo Read more...} */ redo(): Promise; /** * Using the specified session ID an exclusive lock is obtained for the session on the version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#startEditing Read more...} */ startEditing(): Promise; /** * Using the specified session id, the exclusive lock for the version is downgraded to a shared lock. * * @param saveEdits If set to true edits will be saved, if false edits will not be saved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#stopEditing Read more...} */ stopEditing(saveEdits: boolean): Promise; /** * This method undos the last edit made while in an edit session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#undo Read more...} */ undo(): Promise; } /** * This contains basic information about a given version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#VersionInfo Read more...} */ export interface VersionInfo { versionIdentifier: VersionInfoVersionIdentifier; description?: string; access?: string; versionId?: string; creationDate?: number; modifiedDate?: number; reconcileDate?: number; evaluationDate?: number; previousAncestorDate?: number; commonAncestorDate?: number; } /** * This contains extended information about a given version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersioningState.html#VersionInfoExtendedJSON Read more...} */ export interface VersionInfoExtendedJSON { versionIdentifier: VersionInfoExtendedJSONVersionIdentifier; description?: string; access?: "hidden" | "private" | "protected" | "public"; versionId?: string; creationDate?: number; modifiedDate?: number; reconcileDate?: number; evaluationDate?: number; previousAncestorDate?: number; commonAncestorDate?: number; isBeingEdited?: boolean; isBeingRead?: boolean; hasConflicts?: boolean; hasUninspectedConflicts?: boolean; isLocked?: boolean; lockOwner?: string; lockDate?: number; } export interface VersioningStateAlterVersionProps { ownerName?: string; versionName?: string; description?: string; access?: "hidden" | "private" | "protected" | "public"; } export interface VersionInfoVersionIdentifier { name: string; guid: string; } export interface VersionInfoExtendedJSONVersionIdentifier { name: string; guid: string; } export class VersionManagementService { /** * Describes the version management service's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#capabilities Read more...} */ capabilities: VersionManagementServiceCapabilities | nullish; /** * Contains the value for the default version's name and GUID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#defaultVersionIdentifier Read more...} */ defaultVersionIdentifier: VersionIdentifier; /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#loadError Read more...} */ readonly loadError: Error | nullish; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#loadStatus Read more...} */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The name of the version management service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#name Read more...} */ name: string; /** * The absolute URL of the REST endpoint for the version management service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#url Read more...} */ url: string; constructor(properties?: any); /** * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions. * * @param versionIdentifier Identifier for a version. * @param props Contains properties that will be altered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#alterVersion Read more...} */ alterVersion(versionIdentifier: VersionIdentifier, props: VersionManagementServiceAlterVersionProps): Promise; /** * `canRedo` may be used to verify that a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#redo redo} operation is possible. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#canRedo Read more...} */ canRedo(versionIdentifier: VersionIdentifier): boolean; /** * `canUndo` may be used to verify that an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#undo undo} operation is possible. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#canUndo Read more...} */ canUndo(versionIdentifier: VersionIdentifier): boolean; /** * Method used to change a layer's version/moment or network's version/moment. * * @param input Input used to change version on layers or network. * @param fromVersion Current Version or Date moment. * @param toVersion Incoming Version or Date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#changeVersion Read more...} */ changeVersion(input: WebMap | Collection | FeatureLayer[] | Network, fromVersion: Date | VersionIdentifier, toVersion: Date | VersionIdentifier): Promise; /** * Method used to change a layer's version/moment or network's version/moment. * * @param input Input used to change version on layers. * @param fromVersion Current Version or Date moment. * @param toVersion Incoming Version or Date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#changeVersionWithResult Read more...} */ changeVersionWithResult(input: WebMap | Collection | VersionAdapter[], fromVersion: Date | VersionIdentifier, toVersion: Date | VersionIdentifier): Promise>; /** * Creates a new version given the following parameters. * * @param props Contains properties required to create a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#createVersion Read more...} */ createVersion(props: VersionManagementServiceCreateVersionProps): Promise; /** * Deletes a version given the following parameters. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#deleteVersion Read more...} */ deleteVersion(versionIdentifier: VersionIdentifier): Promise; /** * Returns the current client lock type on a given version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#getLockType Read more...} */ getLockType(versionIdentifier: VersionIdentifier): string; /** * This method will return the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#versionIdentifier versionIdentifier} given the guid of the version. * * @param guid GUID of version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#getVersionIdentifierFromGuid Read more...} */ getVersionIdentifierFromGuid(guid: string): Promise; /** * This method will return the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#versionIdentifier versionIdentifier} given the name of the version. * * @param name Name of version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#getVersionIdentifierFromName Read more...} */ getVersionIdentifierFromName(name: string): Promise; /** * Method used to get extended information about a version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#getVersionInfoExtended Read more...} */ getVersionInfoExtended(versionIdentifier: VersionIdentifier): Promise; /** * Returns information about a version or versions. * * @param props * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#getVersionInfos Read more...} */ getVersionInfos(props?: VersionManagementServiceGetVersionInfosProps): Promise; /** * Triggers the loading of the version management service instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#load Read more...} */ load(): Promise; /** * The Post operation allows the client to post the changes in their version to the default version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#post Read more...} */ post(versionIdentifier: VersionIdentifier): Promise; /** * Use the reconcile operation to reconcile a branch version with the default version. * * @param versionIdentifier Identifier for a version. * @param props Properties used for a reconcile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#reconcile Read more...} */ reconcile(versionIdentifier: VersionIdentifier, props: VersionManagementServiceReconcileProps): Promise; /** * This method redos the last edit made while in an edit session. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#redo Read more...} */ redo(versionIdentifier: VersionIdentifier): void; /** * Using the specified session ID an exclusive lock is obtained for the session on the version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#startEditing Read more...} */ startEditing(versionIdentifier: VersionIdentifier): Promise; /** * Using the specified session ID an exclusive lock is obtained for the session on the version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#startEditingWithResult Read more...} */ startEditingWithResult(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. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#startReading Read more...} */ startReading(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. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#startReadingWithResult Read more...} */ startReadingWithResult(versionIdentifier: VersionIdentifier): Promise; /** * Using the specified session id, the exclusive lock for the version is downgraded to a shared lock. * * @param versionIdentifier Identifier for a version. * @param saveEdits If set to true edits will be saved, if false edits will not be saved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#stopEditing Read more...} */ stopEditing(versionIdentifier: VersionIdentifier, saveEdits: boolean): Promise; /** * Using the specified session id, the exclusive lock for the version is downgraded to a shared lock. * * @param versionIdentifier Identifier for a version. * @param saveEdits If set to true edits will be saved, if false edits will not be saved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#stopEditingWithResult Read more...} */ stopEditingWithResult(versionIdentifier: VersionIdentifier, saveEdits: boolean): Promise; /** * The shared lock is released on the version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#stopReading Read more...} */ stopReading(versionIdentifier: VersionIdentifier): Promise; /** * The shared lock is released on the version. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#stopReadingWithResult Read more...} */ stopReadingWithResult(versionIdentifier: VersionIdentifier): Promise; /** * This method undos the last edit made while in an edit session. * * @param versionIdentifier Identifier for a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#undo Read more...} */ undo(versionIdentifier: VersionIdentifier): void; } /** * This contains information about the post result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#PostResult Read more...} */ export interface PostResult { moment: Date | nullish; success: boolean; } /** * This contains information about the reconcile result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#ReconcileResult Read more...} */ export interface ReconcileResult { hasConflicts: boolean; moment: Date | nullish; didPost: boolean; success: boolean; } /** * The response returned after performing an operation using the VersionManagementService. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#ServiceResult Read more...} */ export interface ServiceResult { success: boolean; error?: ServiceResultError; } /** * Contains information on versionable items such as type, current gdbVersion, current historic moment, and the featureService url of the versionable item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionAdapter Read more...} */ export interface VersionAdapter { versionableItem: FeatureLayer | Network | SubtypeGroupLayer; type: "feature-layer" | "subtype-group-layer" | "network"; gdbVersion?: string | nullish; historicMoment?: Date | nullish; featureServiceUrl: string; } /** * Holds the name and guid of a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionIdentifier Read more...} */ export interface VersionIdentifier { name: string; guid: string; } /** * This contains extended information about a given version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionInfoExtendedJSON Read more...} */ export interface VersionManagementServiceVersionInfoExtendedJSON { versionIdentifier: VersionManagementServiceVersionInfoExtendedJSONVersionIdentifier; description?: string; access?: "hidden" | "private" | "protected" | "public"; versionId?: string; creationDate?: number; modifiedDate?: number; reconcileDate?: number; evaluationDate?: number; previousAncestorDate?: number; commonAncestorDate?: number; isBeingEdited?: boolean; isBeingRead?: boolean; hasConflicts?: boolean; hasUninspectedConflicts?: boolean; isLocked?: boolean; lockOwner?: string; lockDate?: number; } /** * This contains basic information about a given version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionInfoJSON Read more...} */ export interface VersionInfoJSON { versionIdentifier: VersionInfoJSONVersionIdentifier; description?: string; access?: string; versionId?: string; creationDate?: number; modifiedDate?: number; reconcileDate?: number; evaluationDate?: number; previousAncestorDate?: number; commonAncestorDate?: number; } export interface VersionManagementServiceAlterVersionProps { ownerName?: string; versionName?: string; description?: string; access?: "hidden" | "private" | "protected" | "public"; } /** * Describes the version management service's supported capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-versionManagement-VersionManagementService.html#VersionManagementServiceCapabilities Read more...} */ export interface VersionManagementServiceCapabilities { supportsConflictDetectionByAttribute: boolean; supportsPartialPost: boolean; supportsDifferencesFromMoment: boolean; supportsDifferencesWithLayers: boolean; supportsAsyncReconcile: boolean; supportsAsyncPost: boolean; supportsAsyncDifferences: boolean; } export interface VersionManagementServiceCreateVersionProps { versionName: string; description?: string; access?: "hidden" | "private" | "protected" | "public"; } export interface VersionManagementServiceGetVersionInfosProps { ownerFilter: string; includeHidden: boolean; } export interface VersionManagementServiceReconcileProps { abortIfConflicts: boolean; conflictDetection: "by-attribute" | "by-object"; withPost: boolean; } export interface ServiceResultError { message: string; extendedCode: number; } export interface VersionManagementServiceVersionInfoExtendedJSONVersionIdentifier { name: string; guid: string; } export interface VersionInfoJSONVersionIdentifier { name: string; guid: string; } export interface Viewpoint extends Accessor, JSONSupport { } export class Viewpoint { /** * The rotation of due north in relation to the top of the view in degrees. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#rotation Read more...} */ rotation: number; /** * The scale of the viewpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#scale Read more...} */ scale: number; /** * Describes a point of view for a 2D or 3D view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Read more...} */ constructor(properties?: ViewpointProperties); /** * The viewpoint camera (3D only). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#camera Read more...} */ get camera(): Camera | nullish; set camera(value: CameraProperties | nullish); /** * The target geometry framed by the viewpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#targetGeometry Read more...} */ get targetGeometry(): GeometryUnion | nullish; set targetGeometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * Create a deep clone of the viewpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#clone Read more...} */ clone(): Viewpoint; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Viewpoint; } interface ViewpointProperties { /** * The viewpoint camera (3D only). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#camera Read more...} */ camera?: CameraProperties | nullish; /** * The rotation of due north in relation to the top of the view in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#rotation Read more...} */ rotation?: number; /** * The scale of the viewpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#scale Read more...} */ scale?: number; /** * The target geometry framed by the viewpoint. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html#targetGeometry Read more...} */ targetGeometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; } export class BaseLayerView2D extends LayerView { /** * The array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#Tile Tile} objects computed to cover the MapView's visible area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#tiles Read more...} */ tiles: Tile[]; /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} this {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#view Read more...} */ view: MapView; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html Read more...} */ constructor(properties?: BaseLayerView2DProperties); /** * Method called when after the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} is created and right before it's asked to draw the layer's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#attach Read more...} */ attach(): void; /** * Method called after the layer is removed and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} is about to be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#detach Read more...} */ detach(): void; /** * Method to implement that is responsible for providing objects hit at the specified screen coordinates. * * @param mapPoint The point in map units. * @param screenPoint The point in screen coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#hitTest Read more...} */ hitTest(mapPoint: Point, screenPoint: ScreenPoint): Promise; /** * The method to implement that is responsible of drawing the content of the layer. * * @param renderParameters * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#render Read more...} */ render(renderParameters: BaseLayerView2DRenderRenderParameters): void; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} can call this method to ask the MapView to schedule a new rendering frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#requestRender Read more...} */ requestRender(): void; /** * Method to implement, which notifies of tiles being added or removed for the current view state. * * @param added The tile objects added for the current view viewport. * @param removed The tile objects removed from the view viewport. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#tilesChanged Read more...} */ tilesChanged(added: Tile[], removed: Tile[]): void; } interface BaseLayerView2DProperties extends LayerViewProperties { /** * The array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#Tile Tile} objects computed to cover the MapView's visible area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#tiles Read more...} */ tiles?: Tile[]; /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} this {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#view Read more...} */ view?: MapView; } export interface BaseLayerView2DRenderRenderParameters { context: CanvasRenderingContext2D; stationary: boolean; state: ViewState; pixelRatio: number; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#ScreenPoint Read more...} */ export interface ScreenPoint { x: number; y: number; } /** * Represents a tile reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerView2D.html#Tile Read more...} */ export interface Tile { id: string; level: number; row: number; col: number; world: number; resolution: number; scale: number; coords: number[]; bounds: number[]; } export class BaseLayerViewGL2D extends LayerView { /** * The WebGL rendering context associated to this layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#context Read more...} */ context: WebGL2RenderingContext; /** * The array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#Tile Tile} objects computed to cover the MapView's visible area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tiles Read more...} */ tiles: BaseLayerViewGL2DTile[]; /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} this {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#view Read more...} */ view: MapView; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html Read more...} */ constructor(properties?: BaseLayerViewGL2DProperties); /** * Method called after the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} is created and right before it starts drawing the layer's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#attach Read more...} */ attach(): void; /** * Bind the designated rendering output surface and restore the correct viewport. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#bindRenderTarget Read more...} */ bindRenderTarget(): void; /** * Method called after the layer is removed and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} is about to be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#detach Read more...} */ detach(): void; /** * Get the designated rendering output surface and corresponding viewport configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#getRenderTarget Read more...} */ getRenderTarget(): RenderTarget; /** * Method to implement that is responsible for providing objects hit at the specified screen coordinates. * * @param mapPoint The point in map units. * @param screenPoint The point in screen coordinates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#hitTest Read more...} */ hitTest(mapPoint: Point, screenPoint: BaseLayerViewGL2DScreenPoint): Promise; /** * The method to implement that is responsible of drawing the content of the layer. * * @param renderParameters * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#render Read more...} */ render(renderParameters: BaseLayerViewGL2DRenderRenderParameters): void; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} can call this method to ask the MapView to schedule a new rendering frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#requestRender Read more...} */ requestRender(): void; /** * Tessellate an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} into a rectangle. * * @param extent The input geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tessellateExtent Read more...} */ tessellateExtent(extent: Extent): Promise; /** * Tessellate a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html Multipoint} into quads (markers). * * @param multipoint The input geometry. These are the geographic points where each marker will me anchored. * @param footprint The rectangle that describes the geometry of each marker. Coordinates x and y can be thought as being in screen-space, relative to the screen-space projection of the geographic point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tessellateMultipoint Read more...} */ tessellateMultipoint(multipoint: Multipoint, footprint: Rect): Promise; /** * Tessellate a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} into a quad (marker). * * @param point The input geometry. This is the geographic point where the marker will me anchored. * @param footprint The rectangle that describes the geometry of the marker. Coordinates `x` and `y` are the position of the upper-left corner of the marker, and can be thought as being in screen-space, relative to the screen-space projection of the geographic point; `width` and `height` are in pixels. See {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#Rect Rect} for a visual explanation of marker geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tessellatePoint Read more...} */ tessellatePoint(point: Point, footprint: Rect): Promise; /** * Tessellate a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} into triangles. * * @param polygon The input geometry. *The geometry must be simple*; if the input geometry is not simple, you must first create a simplified version of it using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html simplifyOperator}, and pass the simplified geometry to `tessellatePolygon`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tessellatePolygon Read more...} */ tessellatePolygon(polygon: Polygon): Promise; /** * Tessellate a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} into triangles. * * @param polyline The input geometry. *The geometry must be simple*; if the input geometry is not simple, you must first create a simplified version of it using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-operators-simplifyOperator.html simplifyOperator}, and pass the simplified geometry to `tessellatePolyline`. * @param width The width of the line; this will be used to scale xOffset and yOffset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tessellatePolyline Read more...} */ tessellatePolyline(polyline: Polyline, width: number): Promise; /** * Method to implement, which notifies of tiles being added or removed for the current view state. * * @param added The tile objects added for the current view viewport. * @param removed The tile objects removed from the view viewport. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tilesChanged Read more...} */ tilesChanged(added: BaseLayerViewGL2DTile[], removed: BaseLayerViewGL2DTile[]): void; } interface BaseLayerViewGL2DProperties extends LayerViewProperties { /** * The WebGL rendering context associated to this layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#context Read more...} */ context?: WebGL2RenderingContext; /** * The array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#Tile Tile} objects computed to cover the MapView's visible area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#tiles Read more...} */ tiles?: BaseLayerViewGL2DTile[]; /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} this {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} belongs to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#view Read more...} */ view?: MapView; } export interface BaseLayerViewGL2DRenderRenderParameters { context: WebGL2RenderingContext; stationary: boolean; state: ViewState; } /** * A vertex of a tessellated mesh. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#MeshVertex Read more...} */ export interface MeshVertex { x: number; y: number; xOffset: number; yOffset: number; uTexcoord: number; vTexcoord: number; distance: number; } /** * A rectangle in screen-space. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#Rect Read more...} */ export interface Rect { x: number; y: number; width: number; height: number; } /** * The destination to which {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#render render()} should direct its output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#RenderTarget Read more...} */ export interface RenderTarget { framebuffer: any; viewport: number[]; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#ScreenPoint Read more...} */ export interface BaseLayerViewGL2DScreenPoint { x: number; y: number; } /** * The triangle mesh resulting from a tessellation operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#TessellatedMesh Read more...} */ export interface TessellatedMesh { vertices: MeshVertex[]; indices: number[]; } /** * Represents a tile reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-layers-BaseLayerViewGL2D.html#Tile Read more...} */ export interface BaseLayerViewGL2DTile { id: string; level: number; row: number; col: number; world: number; resolution: number; scale: number; coords: number[]; 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]`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#center Read more...} */ readonly center: number[]; /** * The extent represents the visible portion of a map within the view as an instance of Extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#extent Read more...} */ readonly extent: Extent; /** * Represents the size of one pixel in map units. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#resolution Read more...} */ readonly resolution: number; /** * The clockwise rotation of due north in relation to the top of the view in degrees. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#rotation Read more...} */ readonly rotation: number; /** * Represents the map scale at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#scale Read more...} */ readonly scale: number; /** * Represents the width and height of the view in pixels, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#size Read more...} */ readonly size: number[]; /** * Object that holds information about the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html Read more...} */ constructor(properties?: ViewStateProperties); /** * Creates a deep clone of ViewState object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#clone Read more...} */ clone(): ViewState; /** * Copies the properties from a given view state. * * @param state The view state to copy the properties from. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#copy Read more...} */ copy(state: ViewState): ViewState; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#toJSON Read more...} */ toJSON(): any; /** * Converts the x and y screen coordinates to map coordinates. * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#toMap Read more...} */ toMap(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#toScreen Read more...} */ toScreen(out: number[], x: number, y: number): number[]; /** * Converts the x and y map coordinates to screen coordinates. * * @param out The receiving array of the conversion. * @param x The horizontal screen coordinate to convert. * @param y The vertical screen coordinate to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#toScreenNoRotation Read more...} */ toScreenNoRotation(out: number[], x: number, y: number): number[]; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-2d-ViewState.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ViewState; } interface ViewStateProperties { } export class AreaMeasurementAnalysisView3D { /** * The area measurement analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#analysis Read more...} */ readonly analysis: AreaMeasurementAnalysis; /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#interactive Read more...} */ interactive: boolean; /** * Result of the area measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#result Read more...} */ result: AreaMeasurementAnalysisResult | nullish; /** * The analysis view type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#type Read more...} */ readonly type: "area-measurement-view-3d"; /** * When `true`, the analysis is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#visible Read more...} */ visible: boolean; constructor(properties?: any); /** * Starts the interactive placement of an area measurement. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#place Read more...} */ place(options?: AreaMeasurementAnalysisView3DPlaceOptions | nullish): Promise; } /** * Result obtained from an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-AreaMeasurementAnalysis.html AreaMeasurementAnalysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-AreaMeasurementAnalysisView3D.html#AreaMeasurementAnalysisResult Read more...} */ export interface AreaMeasurementAnalysisResult { mode: "euclidean" | "geodesic" | nullish; area: Area | nullish; perimeter: Length | nullish; } export interface AreaMeasurementAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface AreaMeasurementPlacementResult { } export class DimensionAnalysisView3D extends Accessor { /** * The dimension analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis Read more...} */ readonly analysis: DimensionAnalysis; /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#interactive Read more...} */ interactive: boolean; /** * Results for each dimension in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#results Read more...} */ readonly results: Collection; /** * The selected dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#selectedDimension Read more...} */ selectedDimension: LengthDimension | nullish; /** * The analysis view type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#type Read more...} */ readonly type: "dimension-view-3d"; /** * When `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis} is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#visible Read more...} */ visible: boolean; /** * Represents the analysis view of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DimensionAnalysis.html DimensionAnalysis} * after it has been added to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#analyses SceneView.analyses}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html Read more...} */ constructor(properties?: DimensionAnalysisView3DProperties); /** * Starts the interactive creation of new dimensions and adds them to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#createLengthDimensions Read more...} */ createLengthDimensions(options?: DimensionAnalysisView3DCreateLengthDimensionsOptions): Promise; /** * Starts the interactive placement of a single dimension, adding it to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#place Read more...} */ place(options?: DimensionAnalysisView3DPlaceOptions | nullish): Promise; } interface DimensionAnalysisView3DProperties { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#interactive Read more...} */ interactive?: boolean; /** * The selected dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#selectedDimension Read more...} */ selectedDimension?: LengthDimension | nullish; /** * When `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#analysis analysis} is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DimensionAnalysisView3D.html#visible Read more...} */ visible?: boolean; } export interface DimensionAnalysisView3DCreateLengthDimensionsOptions { signal?: AbortSignal | nullish; } export interface DimensionAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface DimensionPlacementResult { } export class DirectLineMeasurementAnalysisView3D { /** * The direct line measurement analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#analysis Read more...} */ readonly analysis: DirectLineMeasurementAnalysis; /** * Enables interactivity for the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#interactive Read more...} */ interactive: boolean; /** * Result of the direct line measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#result Read more...} */ result: DirectLineMeasurementAnalysisResult | nullish; /** * The analysis view type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#type Read more...} */ readonly type: "direct-line-measurement-view-3d"; /** * When `true`, the analysis is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#visible Read more...} */ visible: boolean; constructor(properties?: any); /** * Starts the interactive placement of a direct line measurement. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#place Read more...} */ place(options?: DirectLineMeasurementAnalysisView3DPlaceOptions | nullish): Promise; } /** * Result obtained from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-DirectLineMeasurementAnalysis.html DirectLineMeasurementAnalysis}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-DirectLineMeasurementAnalysisView3D.html#DirectLineMeasurementAnalysisResult Read more...} */ export interface DirectLineMeasurementAnalysisResult { mode: "euclidean" | "geodesic"; directDistance: Length; horizontalDistance: Length; verticalDistance: Length; } export interface DirectLineMeasurementAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface DirectLineMeasurementPlacementResult { } export class LineOfSightAnalysisResult { /** * The first {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} intersected by the line of sight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisResult.html#intersectedGraphic Read more...} */ readonly intersectedGraphic: Graphic | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location where the line of * sight first intersects the ground or 3D objects in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisResult.html#intersectedLocation Read more...} */ readonly intersectedLocation: Point | nullish; /** * Represents a target in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html LineOfSightAnalysis} which is used to calculate the visibility * from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-LineOfSightAnalysis.html#observer observer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisResult.html#target Read more...} */ target: LineOfSightAnalysisTarget | nullish; /** * Whether the target is visible from the observer or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisResult.html#visible Read more...} */ readonly visible: boolean; constructor(properties?: any); } export class LineOfSightAnalysisView3D { /** * The line of sight analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis Read more...} */ readonly analysis: LineOfSightAnalysis; /** * Enables interactivity for the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#interactive Read more...} */ interactive: boolean; /** * Analysis results for each target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#results Read more...} */ readonly results: Collection; /** * The analysis view type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#type Read more...} */ readonly type: "line-of-sight-view-3d"; /** * When `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis analysis} is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#visible Read more...} */ visible: boolean; constructor(properties?: any); /** * Starts the interactive placement of an observer and/or targets on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-LineOfSightAnalysisView3D.html#place Read more...} */ place(options?: LineOfSightAnalysisView3DPlaceOptions | nullish): Promise; } export interface LineOfSightAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface LineOfSightPlacementResult { } export class SliceAnalysisView3D { /** * Only one {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-analysis-SliceAnalysis.html SliceAnalysis} at a time can be active in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#active Read more...} */ active: boolean; /** * The slice analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#analysis Read more...} */ readonly analysis: SliceAnalysis; /** * Enables interactivity for the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#interactive Read more...} */ interactive: boolean; readonly type: "slice-view-3d"; /** * When `true`, the analysis is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#visible Read more...} */ visible: boolean; constructor(properties?: any); /** * Starts an interactive operation to pick a layer to exclude from the slice analysis. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#pickLayerToExclude Read more...} */ pickLayerToExclude(options?: SliceAnalysisView3DPickLayerToExcludeOptions | nullish): Promise; /** * Starts the interactive placement of a slice plane. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-SliceAnalysisView3D.html#place Read more...} */ place(options?: SliceAnalysisView3DPlaceOptions | nullish): Promise; } export interface SliceAnalysisView3DPickLayerToExcludeOptions { signal?: AbortSignal | nullish; } export interface SliceAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface SlicePlacementResult { } export class ViewshedAnalysisView3D { /** * The viewshed analysis object associated with the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#analysis Read more...} */ readonly analysis: ViewshedAnalysis; /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#analysis analysis}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#interactive Read more...} */ interactive: boolean; /** * The selected viewshed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#selectedViewshed Read more...} */ selectedViewshed: Viewshed | nullish; /** * The analysis view type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#type Read more...} */ readonly type: "viewshed-view-3d"; /** * When `true`, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#analysis analysis} is visualized in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#visible Read more...} */ visible: boolean; constructor(properties?: any); /** * Starts the interactive creation of new viewsheds and adds them to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#createViewsheds Read more...} */ createViewsheds(options?: ViewshedAnalysisView3DCreateViewshedsOptions | null): Promise; /** * Starts the interactive placement of a single viewshed, adding it to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-analysis-ViewshedAnalysisView3D.html#place Read more...} */ place(options?: ViewshedAnalysisView3DPlaceOptions | nullish): Promise; } export interface ViewshedAnalysisView3DCreateViewshedsOptions { signal?: AbortSignal | nullish; } export interface ViewshedAnalysisView3DPlaceOptions { signal?: AbortSignal | nullish; } export interface ViewshedPlacementResult { } export class CloudyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-CloudyWeather.html#cloudCover Read more...} */ cloudCover: number; /** * The type of weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-CloudyWeather.html#type Read more...} */ readonly type: "cloudy"; /** * The CloudyWeather class allows you to change the weather conditions in the scene to cloudy weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-CloudyWeather.html Read more...} */ constructor(properties?: CloudyWeatherProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-CloudyWeather.html#clone Read more...} */ clone(): CloudyWeather; } interface CloudyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-CloudyWeather.html#cloudCover Read more...} */ cloudCover?: number; } export class FoggyWeather extends Accessor { /** * Specifies the amount of fog used in the scene. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-FoggyWeather.html#fogStrength Read more...} */ fogStrength: number; /** * The type of Weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-FoggyWeather.html#type Read more...} */ readonly type: "foggy"; /** * The FoggyWeather class allows you to change the weather conditions in the scene to foggy weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-FoggyWeather.html Read more...} */ constructor(properties?: FoggyWeatherProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-FoggyWeather.html#clone Read more...} */ clone(): FoggyWeather; } interface FoggyWeatherProperties { /** * Specifies the amount of fog used in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-FoggyWeather.html#fogStrength Read more...} */ fogStrength?: number; } export class RainyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#cloudCover Read more...} */ cloudCover: number; /** * Specifies the amount of falling rain. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#precipitation Read more...} */ precipitation: number; /** * The type of Weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#type Read more...} */ readonly type: "rainy"; /** * The RainyWeather class allows you to change the weather conditions in the scene to rainy weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html Read more...} */ constructor(properties?: RainyWeatherProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#clone Read more...} */ clone(): RainyWeather; } interface RainyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#cloudCover Read more...} */ cloudCover?: number; /** * Specifies the amount of falling rain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-RainyWeather.html#precipitation Read more...} */ precipitation?: number; } export class SnowyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#cloudCover Read more...} */ cloudCover: number; /** * Specifies the amount of falling snow. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#precipitation Read more...} */ precipitation: number; /** * Display surfaces covered with snow. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#snowCover Read more...} */ snowCover: "enabled" | "disabled"; /** * The type of Weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#type Read more...} */ readonly type: "snowy"; /** * The SnowyWeather class allows you to change the weather conditions in the scene to snowy weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html Read more...} */ constructor(properties?: SnowyWeatherProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#clone Read more...} */ clone(): SnowyWeather; } interface SnowyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#cloudCover Read more...} */ cloudCover?: number; /** * Specifies the amount of falling snow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#precipitation Read more...} */ precipitation?: number; /** * Display surfaces covered with snow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SnowyWeather.html#snowCover Read more...} */ snowCover?: "enabled" | "disabled"; } export class SunLighting extends websceneSunLighting { /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunLighting.html#cameraTrackingEnabled Read more...} */ cameraTrackingEnabled: boolean; /** * The SunLighting class allows you to change the lighting in the scene to sunlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunLighting.html Read more...} */ constructor(properties?: SunLightingProperties); } interface SunLightingProperties extends websceneSunLightingProperties { /** * Indicates whether the date and time of the simulated sun is automatically updated to maintain the current time of * day while the camera changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunLighting.html#cameraTrackingEnabled Read more...} */ cameraTrackingEnabled?: boolean; } export class SunnyWeather extends Accessor { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunnyWeather.html#cloudCover Read more...} */ cloudCover: number; /** * The type of weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunnyWeather.html#type Read more...} */ readonly type: "sunny"; /** * The SunnyWeather class allows you to change the weather conditions in the scene to sunny weather. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunnyWeather.html Read more...} */ constructor(properties?: SunnyWeatherProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunnyWeather.html#clone Read more...} */ clone(): SunnyWeather; } interface SunnyWeatherProperties { /** * Specifies the amount of cloud cover in the sky for a certain weather type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-SunnyWeather.html#cloudCover Read more...} */ cloudCover?: number; } export class VirtualLighting extends websceneVirtualLighting { /** * The VirtualLighting class allows you to change the lighting in the scene to virtual light. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-environment-VirtualLighting.html Read more...} */ constructor(properties?: VirtualLightingProperties); } interface VirtualLightingProperties extends websceneVirtualLightingProperties { } /** * This class contains performance information like memory usage and number of features for a specific layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-support-LayerPerformanceInfo.html Read more...} */ interface LayerPerformanceInfo { displayedNumberOfFeatures: number; layer: Layer | nullish; maximumNumberOfFeatures: number | nullish; memory: number; totalNumberOfFeatures: number | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-support-SceneViewPerformanceInfo.html Read more...} */ interface SceneViewPerformanceInfo { edgesMemory: number; layerPerformanceInfos: LayerPerformanceInfo[]; quality: number; terrainMemory: number; totalMemory: number; usedMemory: number; } export const SceneViewPerformanceInfo: SceneViewPerformanceInfo; /** * This module contains convenience functions and typings to work with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html RenderNode}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html Read more...} */ interface webgl { /** * Transforms positions from the internal rendering coordinate system to the output spatial reference. * * @param view The view related to the input coordinates. * @param srcCoordinates A linear array of one or more vectors that are interpreted as XYZ coordinates. For example, two position vectors would be represented as `[x1, y1, z1, x2, y2, z2]`. This must contain at least `srcStart + 3 * count` elements. * @param srcStart An index in `srcCoordinates` from which the coordinates will start being read. * @param destCoordinates A reference to an array in which the results will be written. * @param destStart An index in `destCoordinates` in which the coordinates will start to be written. * @param destSpatialReference The spatial reference of the output coordinates. When `null`, `view.spatialReference` is used instead. * @param count The number of vertices to be transformed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#fromRenderCoordinates Read more...} */ fromRenderCoordinates(view: SceneView, srcCoordinates: number[] | Float32Array | Float64Array, srcStart: number, destCoordinates: number[] | Float32Array | Float64Array, destStart: number, destSpatialReference: SpatialReference, count: number): number[] | Float32Array | Float64Array | nullish; /** * Computes a 4x4 affine transformation matrix that constitutes a linear coordinate transformation from a local * Cartesian coordinate system to the virtual world coordinate system. * * @param view The view for which the transformation will be used. * @param origin The global coordinates of the origin in the local Cartesian coordinate system. * @param srcSpatialReference The spatial reference of the origin coordinates. If undefined, `view.spatialReference` is used instead. * @param dest A reference to an array where the 16 matrix elements will be stored. The resulting matrix follows WebGL conventions where the translation components occupy the 13th, 14th and 15th elements. If undefined, a newly created matrix returned. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#renderCoordinateTransformAt Read more...} */ renderCoordinateTransformAt(view: SceneView, origin: number[] | Float32Array | Float64Array, srcSpatialReference?: SpatialReference, dest?: number[] | Float32Array | Float64Array): number[] | Float32Array | Float64Array | nullish; /** * Transforms positions from the given spatial reference to the internal rendering coordinate system. * * @param view The view in which the coordinates will be used. * @param srcCoordinates A linear array of one or more vectors which are interpreted as XYZ coordinates. For example, two position vectors would be represented as `[x1, y1, z1, x2, y2, z2]`. This must contain at least `srcStart + 3 * count` elements. * @param srcStart An index in `srcCoordinates` from which the coordinates start to be read. * @param srcSpatialReference The spatial reference of the input coordinates. When `null`, `view.spatialReference` is used instead. * @param destCoordinates A reference to an array where the results will be written. * @param destStart An index in `destCoordinates` to which the coordinates will start to be written. * @param count The number of vertices to be transformed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#toRenderCoordinates Read more...} */ toRenderCoordinates(view: SceneView, srcCoordinates: number[] | Float32Array | Float64Array, srcStart: number, srcSpatialReference: SpatialReference, destCoordinates: number[] | Float32Array | Float64Array, destStart: number, count: number): number[] | Float32Array | Float64Array | nullish; } export const webgl: webgl; /** * ManagedFBO is an interface to represent a framebuffer object resource of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html Read more...} */ interface ManagedFBO { readonly name: RenderNodeInput; /** * Acquire and attach a new color texture to this framebuffer. * * @param attachment the WebGL color attachment point for the texture * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#acquireColor Read more...} */ acquireColor(attachment: ColorAttachment): ManagedFBO; /** * Acquire and attach a new depth buffer to this framebuffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#acquireDepth Read more...} */ acquireDepth(): ManagedFBO; /** * Attach a color buffer texture to this framebuffer. * * @param color the color texture to attach. * @param attachment the gl.ColorFormat attachment point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#attachColor Read more...} */ attachColor(color: ManagedColorAttachment, attachment: ColorAttachment): ManagedFBO; /** * Attach a depth buffer texture to this framebuffer. * * @param depth the depth buffer texture to attach. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#attachDepth Read more...} */ attachDepth(depth: ManagedDepthAttachment | nullish): ManagedFBO; /** * Returns a managed color attachment linked to this framebuffer object. * * @param attachment the WebGL color attachment point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#getAttachment Read more...} */ getAttachment(attachment?: ColorAttachment | DepthAttachment): ManagedColorAttachment | ManagedDepthAttachment | nullish; /** * Return the texture for a given color or depth attachment. * * @param attachment a WebGL color or depth attachment point. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#getTexture Read more...} */ getTexture(attachment?: ColorAttachment | DepthAttachment): FBOTexture | nullish; /** * Release this managed framebuffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#release Read more...} */ release(): void; /** * Increase reference counting on this managed framebuffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#retain Read more...} */ retain(): void; } export const ManagedFBO: ManagedFBO; /** * Describes a color attachment point of WebGL2. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ColorAttachment Read more...} */ export interface ColorAttachment { } /** * Describes a depth attachment point of WebGL2. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#DepthAttachment Read more...} */ export interface DepthAttachment { } /** * Encapsulates a WebGL texture. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#FBOTexture Read more...} */ export interface FBOTexture { glName: WebGLTexture | nullish; } /** * Describes a single attachment of a managed framebuffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment Read more...} */ export interface ManagedColorAttachment { /** * Increase reference counting on this managed attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment Read more...} */ retain(): void; /** * Release this managed attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedColorAttachment Read more...} */ release(): void; } /** * Describes the depth attachment of a managed framebuffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment Read more...} */ export interface ManagedDepthAttachment { /** * Increase reference counting on this managed attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment Read more...} */ retain(): void; /** * Release this managed attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-ManagedFBO.html#ManagedDepthAttachment Read more...} */ release(): void; } /** * This is the RenderCamera interface used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderCamera.html Read more...} */ interface RenderCamera { readonly center: ReadonlyArray; readonly eye: ReadonlyArray; readonly far: number; readonly fovX: number; readonly fovY: number; readonly near: number; readonly pixelRatio: number; readonly projectionMatrix: ReadonlyArray; readonly up: ReadonlyArray; readonly viewInverseTransposeMatrix: ReadonlyArray; readonly viewMatrix: ReadonlyArray; readonly viewport: ReadonlyArray; } export const RenderCamera: RenderCamera; export class RenderNode extends Accessor { /** * Get the render representation of the current camera of a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#camera Read more...} */ camera: RenderCamera; /** * Declare which inputs are needed from the engine for rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#consumes Read more...} */ consumes: ConsumedNodes; /** * Returns the current WebGL2RenderingContext instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#gl Read more...} */ gl: WebGL2RenderingContext; /** * Define the output produced by the render function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#produces Read more...} */ produces: RenderNodeOutput; /** * The lighting used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} to render the current frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#sunLight Read more...} */ sunLight: SunLight; /** * The SceneView linked to this render node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#view Read more...} */ view: SceneView; /** * The RenderNode provides low level access to the render pipeline of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} * to create custom visualizations and effects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html Read more...} */ constructor(properties?: RenderNodeProperties); /** * Acquires and binds a managed framebuffer object to be written to and returned by the render function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#acquireOutputFramebuffer Read more...} */ acquireOutputFramebuffer(): ManagedFBO; /** * Bind the color and depth buffers to render into and return the ManagedFBO. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#bindRenderTarget Read more...} */ bindRenderTarget(): ManagedFBO; /** * The render function is called whenever a frame is rendered. * * @param inputs An array of currently provided fbos. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#render Read more...} */ protected render(inputs: ManagedFBO[]): ManagedFBO; /** * Request the SceneView to be redrawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#requestRender Read more...} */ requestRender(): void; /** * Reset WebGL to a well-defined state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#resetWebGLState Read more...} */ resetWebGLState(): void; } interface RenderNodeProperties { /** * Get the render representation of the current camera of a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#camera Read more...} */ camera?: RenderCamera; /** * Declare which inputs are needed from the engine for rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#consumes Read more...} */ consumes?: ConsumedNodes; /** * Returns the current WebGL2RenderingContext instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#gl Read more...} */ gl?: WebGL2RenderingContext; /** * Define the output produced by the render function. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#produces Read more...} */ produces?: RenderNodeOutput; /** * The lighting used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} to render the current frame. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#sunLight Read more...} */ sunLight?: SunLight; /** * The SceneView linked to this render node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#view Read more...} */ view?: SceneView; } /** * Tuple of an RGB color value and an intensity value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#ColorAndIntensity Read more...} */ export interface ColorAndIntensity { color: number[]; intensity: number; } /** * Describes the lighting used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}, derived from its sun * lighting model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl-RenderNode.html#SunLight Read more...} */ export interface SunLight { direction: number[]; diffuse: ColorAndIntensity; ambient: ColorAndIntensity; } /** * Describes the input framebuffer objects of a custom RenderNode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#ConsumedNodes Read more...} */ export interface ConsumedNodes { required: RenderNodeInput[]; optional?: RenderNodeInput[]; } /** * Describes a specific RenderNodeInput. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#RenderNodeInput Read more...} */ export type RenderNodeInput = | "composite-color" | "opaque-color" | "transparent-color" | "final-color" | "normals" | "highlights"; /** * Describes a specific RenderNodeOutput. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-3d-webgl.html#RenderNodeOutput Read more...} */ export type RenderNodeOutput = "composite-color" | "opaque-color" | "transparent-color" | "final-color"; /** * Represents the result of a LengthDimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-analysis-LengthDimensionResult.html Read more...} */ interface LengthDimensionResult { dimension: LengthDimension; length: Length | nullish; } export const LengthDimensionResult: LengthDimensionResult; export class BasemapView extends Accessor { /** * A collection containing a hierarchical list of all the created * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerViews} of the * base layers in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html#baseLayerViews Read more...} */ readonly baseLayerViews: Collection; /** * A collection containing a hierarchical list of all the created * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerViews} of the * reference layers in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html#referenceLayerViews Read more...} */ readonly referenceLayerViews: Collection; /** * Value is `true` when the basemap is updating; for example, if * it is in the process of fetching data. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html#updating Read more...} */ readonly updating: boolean; /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Represents the view for a single basemap after it has been added to either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html Read more...} */ constructor(properties?: BasemapViewProperties); } interface BasemapViewProperties { /** * References the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-BasemapView.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class BreakpointsOwner { breakpoints: BreakpointsOwnerBreakpoints; heightBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"; readonly orientation: "landscape" | "portrait"; widthBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"; } interface BreakpointsOwnerProperties { breakpoints?: BreakpointsOwnerBreakpoints; heightBreakpoint?: "xsmall" | "small" | "medium" | "large" | "xlarge"; widthBreakpoint?: "xsmall" | "small" | "medium" | "large" | "xlarge"; } export interface BreakpointsOwnerBreakpoints { xsmall?: number; small?: number; medium?: number; large?: number; xlarge?: number; } export class DOMContainer { readonly focused: boolean; readonly height: number; readonly resizing: boolean; readonly size: number[]; readonly suspended: boolean; readonly width: number; get container(): HTMLDivElement | nullish; set container(value: HTMLDivElement | nullish | string); get ui(): DefaultUI; set ui(value: DefaultUIProperties); /** * Sets the focus on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-DOMContainer.html#focus Read more...} */ focus(): void; } interface DOMContainerProperties { container?: HTMLDivElement | nullish | string; ui?: DefaultUIProperties; } export class Draw extends Accessor { /** * A reference to the active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html draw action}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#activeAction Read more...} */ activeAction: DrawAction | nullish; /** * The view in which geometries will be drawn by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#view Read more...} */ view: MapView | SceneView; /** * The Draw class provides advanced drawing capabilities for developers who need complete control over * creating temporary graphics with different geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html Read more...} */ constructor(properties?: DrawProperties); /** * Complete the current active drawing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#complete Read more...} */ complete(): void; /** * Creates an instance of the requested draw action. * * @param drawAction * Name of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html draw action} to create. See the table below for a list of possible values and type of draw action it creates. **Possible Values** * * Geometry type | Draw action instance * ------------- | -------------------- * point | {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html PointDrawAction} * multipoint | {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html MultipointDrawAction} (only supported in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}) * polyline | {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html PolylineDrawAction} * polygon | {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html PolygonDrawAction} * rectangle, circle, ellipse | {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html SegmentDrawAction} * @param drawOptions Object of the drawing options for the geometry to be created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#create Read more...} */ create(drawAction: "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "ellipse", drawOptions?: DrawCreateDrawOptions): DrawAction; /** * Resets the drawing by clearing the active action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#reset Read more...} */ reset(): void; } interface DrawProperties { /** * A reference to the active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html draw action}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#activeAction Read more...} */ activeAction?: DrawAction | nullish; /** * The view in which geometries will be drawn by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html#view Read more...} */ view?: MapView | SceneView; } export interface DrawCreateDrawOptions { 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#hasZ Read more...} */ hasZ: boolean; /** * Two-dimensional array of numbers representing the coordinates of each vertex * comprising the geometry being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#vertices Read more...} */ readonly vertices: number[][]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#view Read more...} */ view: MapView | SceneView; /** * DrawAction is the base class for all draw actions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html Read more...} */ constructor(properties?: DrawActionProperties); /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#redo redo()} method can be called on the action instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#canRedo Read more...} */ canRedo(): boolean; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#undo undo()} method can be called on the action instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#canUndo Read more...} */ canUndo(): boolean; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Maps the given screen point to a map point. * * @param screenPoint The location on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#getCoordsAndPointFromScreenPoint Read more...} */ getCoordsAndPointFromScreenPoint(screenPoint: DrawActionScreenPoint): FromScreenPointResult | nullish; /** * Maps the given screen point to a map point. * * @param screenPoint The location on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#getCoordsFromScreenPoint Read more...} */ getCoordsFromScreenPoint(screenPoint: DrawActionScreenPoint | nullish): number[] | nullish; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; /** * Incrementally redo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#redo Read more...} */ redo(): void; /** * Maps the given screen point to a map point. * * @param screenPoint The location on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#screenToMap Read more...} */ screenToMap(screenPoint: DrawActionScreenPoint): Point | nullish; /** * Incrementally undo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#undo Read more...} */ undo(): void; } interface DrawActionProperties { /** * Controls whether the created geometry will have z coordinates or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#hasZ Read more...} */ hasZ?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#view Read more...} */ view?: MapView | SceneView; } /** * The result object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#getCoordsAndPointFromScreenPoint getCoordsAndPointFromScreenPoint()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#FromScreenPointResult Read more...} */ export interface FromScreenPointResult { vertex: number[]; mapPoint: Point; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-DrawAction.html#ScreenPoint Read more...} */ export interface DrawActionScreenPoint { x: number; y: number; } export class MultipointDrawAction extends DrawAction { /** * This class uses the view events to generate a set of coordinates to create a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html Multipoint} * geometry using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html Draw}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html Read more...} */ constructor(properties?: MultipointDrawActionProperties); /** * Completes drawing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Multipoint.html multipoint} geometry and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-draw-complete draw-complete} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#complete Read more...} */ 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; type: "cursor-update"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-cursor-update Read more...} */ preventDefault(): void; } export interface MultipointDrawActionDrawCompleteEvent { defaultPrevented: boolean; type: "draw-complete"; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-draw-complete Read more...} */ preventDefault(): void; } export interface MultipointDrawActionRedoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-redo Read more...} */ preventDefault(): void; } export interface MultipointDrawActionUndoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-undo Read more...} */ preventDefault(): void; } export interface MultipointDrawActionVertexAddEvent { defaultPrevented: boolean; type: "vertex-add"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-vertex-add Read more...} */ preventDefault(): void; } export interface MultipointDrawActionVertexRemoveEvent { defaultPrevented: boolean; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-MultipointDrawAction.html#event-vertex-remove Read more...} */ preventDefault(): void; } export class PointDrawAction extends DrawAction { /** * This class uses the view events to generate a set of coordinates to create a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} * geometry using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html Draw}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html Read more...} */ constructor(properties?: PointDrawActionProperties); /** * Completes drawing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html point} geometry and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html#event-draw-complete draw-complete} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html#complete Read more...} */ 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; type: "cursor-update"; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html#event-cursor-update Read more...} */ preventDefault(): void; } export interface PointDrawActionDrawCompleteEvent { coordinates: number[]; defaultPrevented: boolean; type: "draw-complete"; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PointDrawAction.html#event-draw-complete Read more...} */ preventDefault(): void; } export class PolygonDrawAction extends DrawAction { /** * The drawing mode. * * @default "hybrid" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#mode Read more...} */ mode: "hybrid" | "freehand" | "click"; /** * This class uses different {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#events-summary events} to generate a set of vertices to create a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon} * geometry using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html Draw}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html Read more...} */ constructor(properties?: PolygonDrawActionProperties); /** * Completes drawing the polygon geometry and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-draw-complete draw-complete} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#complete Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#mode Read more...} */ mode?: "hybrid" | "freehand" | "click"; } export interface PolygonDrawActionCursorUpdateEvent { defaultPrevented: boolean; type: "cursor-update"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-cursor-update Read more...} */ preventDefault(): void; } export interface PolygonDrawActionDrawCompleteEvent { defaultPrevented: boolean; type: "draw-complete"; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-draw-complete Read more...} */ preventDefault(): void; } export interface PolygonDrawActionRedoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-redo Read more...} */ preventDefault(): void; } export interface PolygonDrawActionUndoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-undo Read more...} */ preventDefault(): void; } export interface PolygonDrawActionVertexAddEvent { defaultPrevented: boolean; type: "vertex-add"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-vertex-add Read more...} */ preventDefault(): void; } export interface PolygonDrawActionVertexRemoveEvent { defaultPrevented: boolean; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolygonDrawAction.html#event-vertex-remove Read more...} */ preventDefault(): void; } export class PolylineDrawAction extends DrawAction { /** * The drawing mode. * * @default "hybrid" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#mode Read more...} */ mode: "hybrid" | "freehand" | "click"; /** * This class uses different {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#events-summary events} to generate a set of vertices to create a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polyline.html Polyline} * geometry using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-Draw.html Draw}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html Read more...} */ constructor(properties?: PolylineDrawActionProperties); /** * Completes drawing the polyline geometry and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-draw-complete draw-complete} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#complete Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#mode Read more...} */ mode?: "hybrid" | "freehand" | "click"; } export interface PolylineDrawActionCursorUpdateEvent { defaultPrevented: boolean; type: "cursor-update"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-cursor-update Read more...} */ preventDefault(): void; } export interface PolylineDrawActionDrawCompleteEvent { defaultPrevented: boolean; type: "draw-complete"; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-draw-complete Read more...} */ preventDefault(): void; } export interface PolylineDrawActionRedoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-redo Read more...} */ preventDefault(): void; } export interface PolylineDrawActionUndoEvent { defaultPrevented: boolean; type: string; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-undo Read more...} */ preventDefault(): void; } export interface PolylineDrawActionVertexAddEvent { defaultPrevented: boolean; type: "vertex-add"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-vertex-add Read more...} */ preventDefault(): void; } export interface PolylineDrawActionVertexRemoveEvent { defaultPrevented: boolean; type: "vertex-remove"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-PolylineDrawAction.html#event-vertex-remove Read more...} */ preventDefault(): void; } export class SegmentDrawAction extends DrawAction { /** * The drawing mode. * * @default "freehand" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#mode Read more...} */ mode: "freehand" | "click"; /** * This class uses different {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#events-summary events} to generate a set of vertices to create a geometry with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#mode drag mode} or with two clicks. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html Read more...} */ constructor(properties?: SegmentDrawActionProperties); /** * Completes drawing the polygon geometry and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#event-draw-complete draw-complete} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#complete Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#mode Read more...} */ mode?: "freehand" | "click"; } export interface SegmentDrawActionCursorUpdateEvent { defaultPrevented: boolean; type: "cursor-update"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#event-cursor-update Read more...} */ preventDefault(): void; } export interface SegmentDrawActionDrawCompleteEvent { defaultPrevented: boolean; type: "draw-complete"; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#event-draw-complete Read more...} */ preventDefault(): void; } export interface SegmentDrawActionVertexAddEvent { defaultPrevented: boolean; type: "vertex-add"; vertexIndex: number; vertices: number[][]; /** * Prevents event propagation bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-draw-SegmentDrawAction.html#event-vertex-add Read more...} */ preventDefault(): void; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-GroundView.html#elevationSampler Read more...} */ readonly elevationSampler: ElevationSampler | nullish; /** * The extent represents the visible portion of ground within the view as * an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-GroundView.html#extent Read more...} */ readonly extent: Extent | nullish; /** * A collection containing a hierarchical list of all the created * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerViews} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#layers layers} in the ground. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-GroundView.html#layerViews Read more...} */ readonly layerViews: Collection; /** * Value is `true` when any of the ground layer views are updating. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-GroundView.html#updating Read more...} */ readonly updating: boolean; /** * This class represents the view for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html Ground} of a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-GroundView.html Read more...} */ constructor(properties?: GroundViewProperties); } interface GroundViewProperties { } export class GamepadInputDevice extends Accessor { /** * The native Gamepad object exposed by the browser. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadInputDevice.html#native Read more...} */ readonly native: Gamepad | nullish; /** * Properties and configuration of a gamepad. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadInputDevice.html Read more...} */ constructor(properties?: GamepadInputDeviceProperties); } interface GamepadInputDeviceProperties { } export class GamepadSettings extends Accessor { /** * A readonly collection of all gamepads detected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadSettings.html#devices Read more...} */ readonly devices: Collection; /** * Determines what focus is required for gamepad events to be dispatched. * * @default "document" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadSettings.html#enabledFocusMode Read more...} */ enabledFocusMode: "document" | "view" | "none"; /** * Gamepad input specific configuration settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadSettings.html Read more...} */ constructor(properties?: GamepadSettingsProperties); } interface GamepadSettingsProperties { /** * Determines what focus is required for gamepad events to be dispatched. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-gamepad-GamepadSettings.html#enabledFocusMode Read more...} */ enabledFocusMode?: "document" | "view" | "none"; } export class Input extends Accessor { /** * Gamepad input specific configuration settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-Input.html#gamepad Read more...} */ readonly gamepad: GamepadSettings; /** * Input device related configuration settings on the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-input-Input.html Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchLabelOptions.html#enabled Read more...} */ enabled: boolean; /** * The `SketchLabelOptions` allows users to configure the labels which are shown next to each * segment of a graphic while sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchLabelOptions.html Read more...} */ constructor(properties?: SketchLabelOptionsProperties); } interface SketchLabelOptionsProperties { /** * Whether labels are shown next to each segment of the graphic being sketched. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchLabelOptions.html#enabled Read more...} */ enabled?: boolean; } export class SketchTooltipOptions extends Accessor { /** * Whether tooltips are shown while sketching and editing. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#enabled Read more...} */ enabled: boolean; /** * A custom help message that is displayed at the bottom of the tooltip. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#helpMessage Read more...} */ helpMessage: string | nullish; /** * An icon that is displayed next to the help message at the bottom of the tooltip. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#helpMessageIcon Read more...} */ helpMessageIcon: string | nullish; /** * Whether users can focus the tooltip and input constraint values. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#inputEnabled Read more...} */ inputEnabled: boolean; /** * The elements that are displayed within the tooltip while sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#visibleElements Read more...} */ visibleElements: VisibleElements; /** * The `SketchTooltipOptions` allows users to configure the tooltips which are shown while * sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html Read more...} */ constructor(properties?: SketchTooltipOptionsProperties); } interface SketchTooltipOptionsProperties { /** * Whether tooltips are shown while sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#enabled Read more...} */ enabled?: boolean; /** * A custom help message that is displayed at the bottom of the tooltip. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#helpMessage Read more...} */ helpMessage?: string | nullish; /** * An icon that is displayed next to the help message at the bottom of the tooltip. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#helpMessageIcon Read more...} */ helpMessageIcon?: string | nullish; /** * Whether users can focus the tooltip and input constraint values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#inputEnabled Read more...} */ inputEnabled?: boolean; /** * The elements that are displayed within the tooltip while sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#visibleElements Read more...} */ visibleElements?: VisibleElements; } /** * The elements that are displayed within the tooltip while sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchTooltipOptions.html#VisibleElements Read more...} */ export interface VisibleElements { area?: boolean; coordinates?: boolean; direction?: boolean; distance?: boolean; elevation?: boolean; header?: boolean; helpMessage?: boolean; orientation?: boolean; radius?: boolean; rotation?: boolean; scale?: boolean; size?: boolean; totalLength?: boolean; } export class SketchValueOptions extends Accessor { /** * How direction values are displayed and, in case of input, how they are interpreted. * * @default "relative" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#directionMode Read more...} */ directionMode: "relative" | "absolute"; /** * Units used for displaying values in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#displayUnits Read more...} */ displayUnits: Units; /** * Units used for interpreting input values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#inputUnits Read more...} */ inputUnits: Units; /** * The `SketchValueOptions` allows users to configure how numerical values and * constraints behave while sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html Read more...} */ constructor(properties?: SketchValueOptionsProperties); } interface SketchValueOptionsProperties { /** * How direction values are displayed and, in case of input, how they are interpreted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#directionMode Read more...} */ directionMode?: "relative" | "absolute"; /** * Units used for displaying values in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#displayUnits Read more...} */ displayUnits?: Units; /** * Units used for interpreting input values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#inputUnits Read more...} */ inputUnits?: Units; } /** * Units used for displaying or interpreting values in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-sketch-SketchValueOptions.html#Units Read more...} */ export interface Units { length?: SystemOrLengthUnit | nullish; verticalLength?: SystemOrLengthUnit | nullish; area?: SystemOrAreaUnit | nullish; } export class FeatureSnappingLayerSource extends Accessor { /** * Indicates whether feature snapping is turned on or off. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-FeatureSnappingLayerSource.html#enabled Read more...} */ enabled: boolean; /** * The source layer used for snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-FeatureSnappingLayerSource.html#layer Read more...} */ readonly layer: | BuildingSceneLayer | CSVLayer | FeatureLayer | GeoJSONLayer | GraphicsLayer | MapNotesLayer | SceneLayer | SubtypeSublayer | WFSLayer; /** * The FeatureSnappingLayerSource specifies which layers will be utilized for snapping in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-FeatureSnappingLayerSource.html Read more...} */ constructor(properties?: FeatureSnappingLayerSourceProperties); } interface FeatureSnappingLayerSourceProperties { /** * Indicates whether feature snapping is turned on or off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-FeatureSnappingLayerSource.html#enabled Read more...} */ enabled?: boolean; /** * The source layer used for snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-FeatureSnappingLayerSource.html#layer Read more...} */ layer?: | BuildingSceneLayer | CSVLayer | FeatureLayer | GeoJSONLayer | GraphicsLayer | MapNotesLayer | SceneLayer | SubtypeSublayer | WFSLayer; } export class SnappingOptions extends Accessor { /** * When true, enables support for attribute rule-based snapping. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#attributeRulesEnabled Read more...} */ attributeRulesEnabled: boolean; /** * Snapping distance for snapping in pixels. * * @default 5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#distance Read more...} */ distance: number; /** * Global configuration to turn snapping on or off. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#enabled Read more...} */ enabled: boolean; /** * Global configuration option to turn feature snapping on or off. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#featureEnabled Read more...} */ featureEnabled: boolean; /** * Turns the grid on or off. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#gridEnabled Read more...} */ gridEnabled: boolean; /** * Global configuration option to turn self snapping (within one feature while * either drawing or reshaping) on or off. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#selfEnabled Read more...} */ selfEnabled: boolean; /** * The `SnappingOptions` allows users to configure snapping for their editing or drawing experience in both the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#snappingOptions Sketch} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#snappingOptions Editor} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html Read more...} */ constructor(properties?: SnappingOptionsProperties); /** * List of sources for feature snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#featureSources Read more...} */ get featureSources(): Collection; set featureSources(value: CollectionProperties); } interface SnappingOptionsProperties { /** * When true, enables support for attribute rule-based snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#attributeRulesEnabled Read more...} */ attributeRulesEnabled?: boolean; /** * Snapping distance for snapping in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#distance Read more...} */ distance?: number; /** * Global configuration to turn snapping on or off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#enabled Read more...} */ enabled?: boolean; /** * Global configuration option to turn feature snapping on or off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#featureEnabled Read more...} */ featureEnabled?: boolean; /** * List of sources for feature snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#featureSources Read more...} */ featureSources?: CollectionProperties; /** * Turns the grid on or off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#gridEnabled Read more...} */ gridEnabled?: boolean; /** * Global configuration option to turn self snapping (within one feature while * either drawing or reshaping) on or off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html#selfEnabled Read more...} */ selfEnabled?: boolean; } export class Tooltip extends Accessor { /** * The current mode the tooltip is in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-Tooltip.html#mode Read more...} */ readonly mode: "feedback" | "input"; /** * Object which represents a tooltip that is shown while sketching and editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-Tooltip.html Read more...} */ constructor(properties?: TooltipProperties); } interface TooltipProperties { } export class BuildingComponentSublayerView extends Accessor { /** * A list of attribute fields fetched for each feature including fields required for layer * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#renderer rendering} and additional fields defined on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html#outFields BuildingComponentSublayer.outFields} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html#outFields BuildingSceneLayer.outFields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#availableFields Read more...} */ readonly availableFields: string[]; /** * The sublayer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#sublayer Read more...} */ readonly sublayer: BuildingComponentSublayer; /** * Value is `true` if the sublayer is suspended (i.e., sublayer will not redraw or update * itself when the extent changes). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#suspended Read more...} */ readonly suspended: boolean; /** * Value is `true` when the sublayer is updating; for example, if * it is in the process of fetching data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#updating Read more...} */ readonly updating: boolean; /** * Represents the sublayer view of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html BuildingComponentSublayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html Read more...} */ constructor(properties?: BuildingComponentSublayerViewProperties); /** * Applies a client-side {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html FeatureFilter} to the displayed data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s). * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[]): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view and * returns the 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: BuildingComponentSublayerViewQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: BuildingComponentSublayerViewQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned along with their attributes specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#availableFields availableFields}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: BuildingComponentSublayerViewQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in * the layer view and returns an array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes of the query. If query parameters are not provided, all loaded features are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: BuildingComponentSublayerViewQueryObjectIdsOptions): Promise; } interface BuildingComponentSublayerViewProperties { /** * Applies a client-side {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html FeatureFilter} to the displayed data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; } export interface BuildingComponentSublayerViewQueryExtentOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerViewQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerViewQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface BuildingComponentSublayerViewQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export class BuildingSceneLayerView extends LayerView { /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingSceneLayerView.html#layer Read more...} */ readonly layer: BuildingSceneLayer; /** * Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingComponentSublayerView.html sublayer views} for all the * component sublayers of the BuildingSceneLayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingSceneLayerView.html#sublayerViews Read more...} */ readonly sublayerViews: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingSceneLayerView.html Read more...} */ constructor(properties?: BuildingSceneLayerViewProperties); /** * Highlights the given feature(s). * * @param target The feature(s) to highlight. The graphics that are passed to this function must originate from one of the component sublayers of the BuildigSceneLayer. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-BuildingSceneLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[], options?: BuildingSceneLayerViewHighlightOptions): Handle; } interface BuildingSceneLayerViewProperties extends LayerViewProperties { } export interface BuildingSceneLayerViewHighlightOptions { name?: string; } export class CatalogDynamicGroupLayerView extends LayerView { /** * A collection of layer views within the CatalogDynamicGroupLayerView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogDynamicGroupLayerView.html#layerViews Read more...} */ readonly layerViews: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer CatalogLayer's dynamicGroupLayer} * after the CatalogLayer has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogDynamicGroupLayerView.html Read more...} */ constructor(properties?: CatalogDynamicGroupLayerViewProperties); } interface CatalogDynamicGroupLayerViewProperties extends LayerViewProperties { } export interface CatalogFootprintLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class CatalogFootprintLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#footprintLayer CatalogLayer's footprintLayer} * after the CatalogLayer has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html Read more...} */ constructor(properties?: CatalogFootprintLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface CatalogFootprintLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class CatalogLayerView extends LayerView { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogDynamicGroupLayerView.html CatalogDynamicGroupLayerView} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer CatalogLayer's dynamicGroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogLayerView.html#dynamicGroupLayerView Read more...} */ readonly dynamicGroupLayerView: CatalogDynamicGroupLayerView | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogFootprintLayerView.html CatalogFootprintLayerView} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#footprintLayer CatalogLayer's footprintLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogLayerView.html#footprintLayerView Read more...} */ readonly footprintLayerView: CatalogFootprintLayerView | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} instances associated with this layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogLayerView.html#layerViews Read more...} */ readonly layerViews: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CatalogLayerView.html Read more...} */ constructor(properties?: CatalogLayerViewProperties); } interface CatalogLayerViewProperties extends LayerViewProperties { } export interface CSVLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class CSVLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html Read more...} */ constructor(properties?: CSVLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface CSVLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-CSVLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class DimensionLayerView extends LayerView { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#layer layer}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#interactive Read more...} */ interactive: boolean; /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#layer Read more...} */ readonly layer: DimensionLayer; /** * Results for each dimension in the layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#source source}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#results Read more...} */ readonly results: Collection; /** * The selected dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#selectedDimension Read more...} */ selectedDimension: LengthDimension | nullish; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html DimensionLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html Read more...} */ constructor(properties?: DimensionLayerViewProperties); /** * Starts the interactive creation of new dimensions and adds them to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#layer layer}'s * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#source source}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#createLengthDimensions Read more...} */ createLengthDimensions(options?: DimensionLayerViewCreateLengthDimensionsOptions | null): Promise; /** * Starts the interactive placement of a single dimension, adding it to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#layer layer}'s * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-DimensionLayer.html#source source}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#place Read more...} */ place(options?: DimensionLayerViewPlaceOptions | nullish): Promise; } interface DimensionLayerViewProperties extends LayerViewProperties { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#interactive Read more...} */ interactive?: boolean; /** * The selected dimension. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-DimensionLayerView.html#selectedDimension Read more...} */ selectedDimension?: LengthDimension | nullish; } export interface DimensionLayerViewCreateLengthDimensionsOptions { signal?: AbortSignal | nullish; } export interface DimensionLayerViewPlaceOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class FeatureLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#layer Read more...} */ readonly layer: FeatureLayer; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html Read more...} */ constructor(properties?: FeatureLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface FeatureLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class FeatureLayerViewMixin { readonly availableFields: string[]; readonly dataUpdating: boolean; readonly hasAllFeatures: boolean; readonly hasAllFeaturesInView: boolean; readonly hasFullGeometries: boolean; maximumNumberOfFeatures: number; maximumNumberOfFeaturesExceeded: boolean; get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#createQuery Read more...} */ createQuery(): Query; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-FeatureLayerViewMixin.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface FeatureLayerViewMixinProperties { featureEffect?: FeatureEffectProperties | nullish; filter?: FeatureFilterProperties | nullish; maximumNumberOfFeatures?: number; maximumNumberOfFeaturesExceeded?: boolean; } export interface FeatureLayerViewMixinQueryAggregatesOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerViewMixinQueryAttributeBinsOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerViewMixinQueryExtentOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerViewMixinQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerViewMixinQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface FeatureLayerViewMixinQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface GeoJSONLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class GeoJSONLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html Read more...} */ constructor(properties?: GeoJSONLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface GeoJSONLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoJSONLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class GeoRSSLayerView extends LayerView { /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoRSSLayer.html GeoRSSLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GeoRSSLayerView.html Read more...} */ constructor(properties?: GeoRSSLayerViewProperties); } interface GeoRSSLayerViewProperties extends LayerViewProperties { } export interface GraphicsLayerView extends LayerView, HighlightLayerViewMixin { } export class GraphicsLayerView { /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GraphicsLayerView.html Read more...} */ constructor(properties?: GraphicsLayerViewProperties); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GraphicsLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GraphicsLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Returns all graphics available for drawing in the layer view * as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html collection}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GraphicsLayerView.html#queryGraphics Read more...} */ queryGraphics(): Promise>; } interface GraphicsLayerViewProperties extends LayerViewProperties, HighlightLayerViewMixinProperties { /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GraphicsLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; } export class GroupLayerView extends LayerView { /** * A collection of layer views within the GroupLayerView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GroupLayerView.html#layerViews Read more...} */ layerViews: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html GroupLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GroupLayerView.html Read more...} */ constructor(properties?: GroupLayerViewProperties); } interface GroupLayerViewProperties extends LayerViewProperties { /** * A collection of layer views within the GroupLayerView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-GroupLayerView.html#layerViews Read more...} */ layerViews?: Collection; } export class HighlightLayerViewMixin { get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-HighlightLayerViewMixin.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; } interface HighlightLayerViewMixinProperties { highlightOptions?: HighlightOptionsProperties | nullish; } export interface HighlightLayerViewMixinHighlightOptions { name?: string; } export class ImageryLayerView extends LayerView { /** * An object that provides the user access to * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixels pixels} and their values in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#pixelData Read more...} */ pixelData: PixelData | nullish; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html Read more...} */ constructor(properties?: ImageryLayerViewProperties); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Returns the map scale that corresponds to the source level of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#getSourceScale Read more...} */ getSourceScale(): Promise; /** * Highlights the given feature(s) in an ImageryLayerView. * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | Collection, options?: ImageryLayerViewHighlightOptions): Handle; } interface ImageryLayerViewProperties extends LayerViewProperties { /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * An object that provides the user access to * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-PixelBlock.html#pixels pixels} and their values in the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryLayerView.html#pixelData Read more...} */ pixelData?: PixelData | nullish; } export interface ImageryLayerViewHighlightOptions { name?: string; } export class ImageryTileLayerView extends LayerView { /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryTileLayer.html ImageryTileLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryTileLayerView.html Read more...} */ constructor(properties?: ImageryTileLayerViewProperties); /** * Returns the map scale that corresponds to the source level of raster data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ImageryTileLayerView.html#getSourceScale Read more...} */ getSourceScale(): Promise; } interface ImageryTileLayerViewProperties extends LayerViewProperties { } export class KMLLayerView extends LayerView { /** * A collection of all the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#MapImage MapImages} from visible sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#allVisibleMapImages Read more...} */ readonly allVisibleMapImages: Collection; /** * A collection of graphics representing all the points from visible sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#allVisiblePoints Read more...} */ readonly allVisiblePoints: Collection; /** * A collection of graphics representing all the polygons from visible sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#allVisiblePolygons Read more...} */ readonly allVisiblePolygons: Collection; /** * A collection of graphics representing all the polylines from visible sublayers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#allVisiblePolylines Read more...} */ readonly allVisiblePolylines: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KMLLayer.html KMLLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html Read more...} */ constructor(properties?: KMLLayerViewProperties); } interface KMLLayerViewProperties extends LayerViewProperties { } /** * **MapImage** represents an image overlay draped onto the terrain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-KMLLayerView.html#MapImage Read more...} */ export interface KMLLayerViewMapImage { id: number; href: string; extent: Extent; rotation: number; } export interface LayerView extends Accessor, corePromise, Identifiable { } export class LayerView { /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#layer Read more...} */ readonly layer: Layer; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#spatialReference spatialReference} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} is supported by the layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#spatialReferenceSupported Read more...} */ readonly spatialReferenceSupported: boolean; /** * Value is `true` if the layer is suspended (i.e., layer will not redraw or update * itself when the extent changes). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#suspended Read more...} */ readonly suspended: boolean; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates if the layer view is making any updates that will impact what is displayed on the map. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#updating Read more...} */ readonly updating: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} associated with the layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#view Read more...} */ readonly view: MapView | SceneView; /** * When `true`, the layer is visible in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#visible Read more...} */ visible: boolean; /** * When `true`, the layer is visible in the view at the current scale. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#visibleAtCurrentScale Read more...} */ readonly visibleAtCurrentScale: boolean; /** * When `true`, the layer is visible in the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent timeExtent}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#visibleAtCurrentTimeExtent Read more...} */ readonly visibleAtCurrentTimeExtent: boolean; /** * Represents the view for a single layer after it has been added to either a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html Read more...} */ constructor(properties?: LayerViewProperties); /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#isResolved Read more...} */ isResolved(): boolean; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface LayerViewProperties extends IdentifiableProperties { /** * When `true`, the layer is visible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html#visible Read more...} */ visible?: boolean; } export class LineOfSightLayerView extends LayerView { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#layer layer}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#interactive Read more...} */ interactive: boolean; /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#layer Read more...} */ readonly layer: LineOfSightLayer; /** * Analysis results for each target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#results Read more...} */ readonly results: Collection; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html LineOfSightLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html Read more...} */ constructor(properties?: LineOfSightLayerViewProperties); /** * Starts the interactive placement of an observer and/or targets on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#layer layer}'s * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LineOfSightLayer.html#analysis analysis}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#place Read more...} */ place(options?: LineOfSightLayerViewPlaceOptions | nullish): Promise; } interface LineOfSightLayerViewProperties extends LayerViewProperties { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LineOfSightLayerView.html#interactive Read more...} */ interactive?: boolean; } export interface LineOfSightLayerViewPlaceOptions { signal?: AbortSignal | nullish; } export class MediaLayerView extends LayerView { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#layer layer}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#interactive Read more...} */ interactive: boolean; /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#layer Read more...} */ readonly layer: MediaLayer; /** * The selected element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#selectedElement Read more...} */ selectedElement: ImageElement | VideoElement | nullish; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html Read more...} */ constructor(properties?: MediaLayerViewProperties); /** * Options for when the layer view is interactive. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#interactionOptions Read more...} */ get interactionOptions(): MediaLayerViewInteractionOptions; set interactionOptions(value: MediaLayerViewInteractionOptionsProperties); /** * Highlights the given media element(s) in a MediaLayerView. * * @param target The media element(s) to highlight. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#highlight Read more...} */ highlight(target: ImageElement | VideoElement | Iterable, options?: MediaLayerViewHighlightOptions): Handle; } interface MediaLayerViewProperties extends LayerViewProperties { /** * Options for when the layer view is interactive. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#interactionOptions Read more...} */ interactionOptions?: MediaLayerViewInteractionOptionsProperties; /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#interactive Read more...} */ interactive?: boolean; /** * The selected element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-MediaLayerView.html#selectedElement Read more...} */ selectedElement?: ImageElement | VideoElement | nullish; } export interface MediaLayerViewHighlightOptions { name?: string; } export interface MediaLayerViewInteractionOptionsProperties { tool?: "transform" | "reshape"; reshapeOptions?: MediaLayerViewInteractionOptionsReshapeOptionsProperties; } export interface MediaLayerViewInteractionOptions extends AnonymousAccessor { get reshapeOptions(): MediaLayerViewInteractionOptionsReshapeOptions; set reshapeOptions(value: MediaLayerViewInteractionOptionsReshapeOptionsProperties); tool: "transform" | "reshape"; } export interface MediaLayerViewInteractionOptionsReshapeOptionsProperties { editSourcePoints?: boolean; } export interface MediaLayerViewInteractionOptionsReshapeOptions extends AnonymousAccessor { editSourcePoints: boolean; } export interface OGCFeatureLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class OGCFeatureLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html OGCFeatureLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html Read more...} */ constructor(properties?: OGCFeatureLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface OGCFeatureLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-OGCFeatureLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export interface ParquetLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class ParquetLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ParquetLayer.html ParquetLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html Read more...} */ constructor(properties?: ParquetLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface ParquetLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ParquetLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class PointCloudLayerView extends LayerView { /** * A list of attribute fields fetched for each point including fields required for layer * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#renderer rendering} and additional fields defined on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html#outFields outFields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#availableFields Read more...} */ readonly availableFields: string[]; /** * The point cloud layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#layer Read more...} */ readonly layer: PointCloudLayer; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-PointCloudLayer.html PointCloudLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html Read more...} */ constructor(properties?: PointCloudLayerViewProperties); /** * Creates query parameter object that can be used to fetch points as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given point(s). * * @param target The point(s) to highlight. A graphic representing a point to highlight can be obtained by using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest SceneView.hitTest()}. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | Collection, options?: PointCloudLayerViewHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against points in the layer view and * returns the 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of points that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all points on the client are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: PointCloudLayerViewQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against points in the layer view * and returns the number of points that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all points on the client are returned. To only return points visible in the view, set the `geometry` parameter in the query object to the view's visible area. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: PointCloudLayerViewQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against points in the layer view * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all points on the client are returned along with their attributes specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#availableFields availableFields}. To only return points visible in the view, set the `geometry` parameter in the query object to the view's visible area. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-PointCloudLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: PointCloudLayerViewQueryFeaturesOptions): Promise; } interface PointCloudLayerViewProperties extends LayerViewProperties { } export interface PointCloudLayerViewHighlightOptions { name?: string; } export interface PointCloudLayerViewQueryExtentOptions { signal?: AbortSignal | nullish; } export interface PointCloudLayerViewQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface PointCloudLayerViewQueryFeaturesOptions { signal?: AbortSignal | nullish; } export class SceneLayerView extends LayerView { /** * A list of attribute fields fetched for each feature including fields required for layer * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#renderer rendering} and additional fields defined on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html#outFields SceneLayer.outFields}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#availableFields Read more...} */ readonly availableFields: string[]; /** * The scene layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#layer Read more...} */ readonly layer: SceneLayer; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures: number; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ readonly maximumNumberOfFeaturesExceeded: boolean; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html Read more...} */ constructor(properties?: SceneLayerViewProperties); /** * Applies a client-side {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html FeatureFilter} to the displayed data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Creates query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s). * * @param target The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number or an array. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[], options?: SceneLayerViewHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view and * returns the 3D {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features on the client are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: SceneLayerViewQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features on the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's visible area. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: SceneLayerViewQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in the layer view * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features on the client are returned along with their attributes specified in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#availableFields availableFields}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's visible area. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: SceneLayerViewQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features in * the layer view and returns an array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes of the query. If query parameters are not provided, all loaded features are returned. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: SceneLayerViewQueryObjectIdsOptions): Promise<(number | string)[]>; } interface SceneLayerViewProperties extends LayerViewProperties { /** * Applies a client-side {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html FeatureFilter} to the displayed data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-SceneLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: number; } export interface SceneLayerViewHighlightOptions { name?: string; } export interface SceneLayerViewQueryExtentOptions { signal?: AbortSignal | nullish; } export interface SceneLayerViewQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface SceneLayerViewQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface SceneLayerViewQueryObjectIdsOptions { signal?: AbortSignal | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#connectionError Read more...} */ readonly connectionError: Error | nullish; /** * The status of the Web Socket connection with the stream service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#connectionStatus Read more...} */ readonly connectionStatus: "connected" | "disconnected" | "paused"; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html StreamLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html Read more...} */ constructor(properties?: StreamLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Connects to a stream service web socket. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#connect Read more...} */ connect(): void; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Disconnects from a stream service web socket. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#disconnect Read more...} */ disconnect(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Pauses the connection and stops new observations from being applied until {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#resume resume()} is called. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#pause Read more...} */ pause(): void; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes, spatial, and temporal filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: StreamLayerViewQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes, spatial, and temporal filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: StreamLayerViewQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes, spatial, and temporal filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: StreamLayerViewQueryFeaturesOptions): Promise; /** * If a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-TimeInfo.html#trackIdField trackIdField} is specified on the stream service, * this method executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet} of the latest observations for each `trackId` * that satisfy the query. * * @param query Specifies the attributes, spatial, and temporal filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#queryLatestObservations Read more...} */ queryLatestObservations(query?: QueryProperties, options?: StreamLayerViewQueryLatestObservationsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes, spatial, and temporal filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: StreamLayerViewQueryObjectIdsOptions): Promise; /** * Resumes the connection and the new observations will be applied. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#resume Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-StreamLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; } export interface StreamLayerViewDataReceivedEvent { attributes: any; geometry: any; } export interface StreamLayerViewMessageReceivedEvent { message: any; } export interface StreamLayerViewQueryExtentOptions { signal?: AbortSignal | nullish; } export interface StreamLayerViewQueryFeatureCountOptions { signal?: AbortSignal | nullish; } export interface StreamLayerViewQueryFeaturesOptions { signal?: AbortSignal | nullish; } export interface StreamLayerViewQueryLatestObservationsOptions { signal?: AbortSignal | nullish; } export interface StreamLayerViewQueryObjectIdsOptions { signal?: AbortSignal | nullish; } export interface StreamLayerViewUpdateRateEvent { client: number; websocket: number; } export class VectorTileLayerView extends LayerView { /** * When `false`, it indicates that tiles have no visible features within the current extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-VectorTileLayerView.html#hasVisibleFeatures Read more...} */ readonly hasVisibleFeatures: boolean; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VectorTileLayer.html VectorTileLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-VectorTileLayerView.html Read more...} */ constructor(properties?: VectorTileLayerViewProperties); } interface VectorTileLayerViewProperties extends LayerViewProperties { } export class ViewshedLayerView extends LayerView { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#layer layer}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#interactive Read more...} */ interactive: boolean; /** * The layer being viewed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#layer Read more...} */ readonly layer: ViewshedLayer; /** * The selected viewshed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#selectedViewshed Read more...} */ selectedViewshed: Viewshed | nullish; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html ViewshedLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html Read more...} */ constructor(properties?: ViewshedLayerViewProperties); /** * Starts the interactive creation of new viewsheds and adds them to the layer * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#source source}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#createViewsheds Read more...} */ createViewsheds(options?: ViewshedLayerViewCreateViewshedsOptions | null): Promise; /** * Starts the interactive placement of a single viewshed, adding it to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#layer layer}'s * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ViewshedLayer.html#source source}. * * @param options An object specifying additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#place Read more...} */ place(options?: ViewshedLayerViewPlaceOptions | nullish): Promise; } interface ViewshedLayerViewProperties extends LayerViewProperties { /** * Enables interactivity for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#interactive Read more...} */ interactive?: boolean; /** * The selected viewshed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-ViewshedLayerView.html#selectedViewshed Read more...} */ selectedViewshed?: Viewshed | nullish; } export interface ViewshedLayerViewCreateViewshedsOptions { signal?: AbortSignal | nullish; } export interface ViewshedLayerViewPlaceOptions { signal?: AbortSignal | nullish; } export interface WFSLayerView extends LayerView, FeatureLayerViewMixin, HighlightLayerViewMixin { } export class WFSLayerView { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#availableFields Read more...} */ declare readonly availableFields: FeatureLayerViewMixin["availableFields"]; /** * Indicates whether the layer view is currently fetching new features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#dataUpdating Read more...} */ declare readonly dataUpdating: FeatureLayerViewMixin["dataUpdating"]; /** * Indicates whether the layer view contains all available features from the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#hasAllFeatures Read more...} */ declare readonly hasAllFeatures: FeatureLayerViewMixin["hasAllFeatures"]; /** * This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible * (for example, if the result is zero). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#hasAllFeaturesInView Read more...} */ declare readonly hasAllFeaturesInView: FeatureLayerViewMixin["hasAllFeaturesInView"]; /** * Indicates whether the layer view has geometries at full resolution. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#hasFullGeometries Read more...} */ declare readonly hasFullGeometries: FeatureLayerViewMixin["hasFullGeometries"]; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#maximumNumberOfFeatures Read more...} */ declare maximumNumberOfFeatures: FeatureLayerViewMixin["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ declare maximumNumberOfFeaturesExceeded: FeatureLayerViewMixin["maximumNumberOfFeaturesExceeded"]; /** * Represents the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} * after it has been added to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} in either a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html Read more...} */ constructor(properties?: WFSLayerViewProperties); /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#featureEffect Read more...} */ get featureEffect(): FeatureEffect | nullish; set featureEffect(value: FeatureEffectProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#filter Read more...} */ get filter(): FeatureFilter | nullish; set filter(value: FeatureFilterProperties | nullish); /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions | nullish; set highlightOptions(value: HighlightOptionsProperties | nullish); /** * Creates query parameter object that can be used to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryAggregates fetch aggregate features} as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#createAggregateQuery Read more...} */ createAggregateQuery(): Query; /** * Creates a query parameter object that can be used to fetch features as they are being * displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#createQuery Read more...} */ createQuery(): Query; /** * Highlights the given feature(s) in a layer view using the named {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} * from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * @param target The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid `objectID`. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#highlight Read more...} */ highlight(target: Graphic | Graphic[] | number | number[] | string | string[], options?: HighlightLayerViewMixinHighlightOptions): Handle; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against aggregate features (i.e. * * @param query Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryAggregates Read more...} */ queryAggregates(query?: QueryProperties, options?: FeatureLayerViewMixinQueryAggregatesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html AttributeBinsQuery} against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsFeatureSet.html AttributeBinsFeatureSet} containing the series of bins. * * @param binsQuery Specifies the parameters of the `queryAttributeBins()` operation. The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-AttributeBinsQuery.html#binParameters binParameters} property must be set. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryAttributeBins Read more...} */ queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: FeatureLayerViewMixinQueryAttributeBinsOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView and * returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryExtent Read more...} */ queryExtent(query?: QueryProperties, options?: FeatureLayerViewMixinQueryExtentOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns the number of features that satisfy the query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryFeatureCount Read more...} */ queryFeatureCount(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeatureCountOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in the layerView * and returns a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-FeatureSet.html FeatureSet}. * * @param query Specifies the attributes and spatial filter of the query. When this parameter is not passed to `queryFeatures()` method, then a default query is created using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#createQuery createQuery()} method and all features that pass the layer view {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#filter filter} are returned along with their attributes that are {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#availableFields available on the client}. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryFeatures Read more...} */ queryFeatures(query?: QueryProperties, options?: FeatureLayerViewMixinQueryFeaturesOptions): Promise; /** * Executes a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-Query.html Query} against features available for drawing in * the layerView and returns array of the ObjectIDs of features that satisfy the input query. * * @param query Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the `geometry` parameter in the query object to the view's extent. * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#queryObjectIds Read more...} */ queryObjectIds(query?: QueryProperties, options?: FeatureLayerViewMixinQueryObjectIdsOptions): Promise<(number | string)[]>; } interface WFSLayerViewProperties extends LayerViewProperties, FeatureLayerViewMixinProperties, HighlightLayerViewMixinProperties { /** * The featureEffect can be used to draw attention features of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#featureEffect Read more...} */ featureEffect?: FeatureEffectProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#where attribute}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#geometry geometry}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureFilter.html#timeExtent time extent} * filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#filter Read more...} */ filter?: FeatureFilterProperties | nullish; /** * Options for configuring the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties | nullish; /** * The maximum number of features that can be displayed at a time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#maximumNumberOfFeatures Read more...} */ maximumNumberOfFeatures?: FeatureLayerViewMixinProperties["maximumNumberOfFeatures"]; /** * Signifies whether the maximum number of features has been exceeded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-WFSLayerView.html#maximumNumberOfFeaturesExceeded Read more...} */ maximumNumberOfFeaturesExceeded?: FeatureLayerViewMixinProperties["maximumNumberOfFeaturesExceeded"]; } export class LinkChartView extends View2D { /** * LinkChartView is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html 2D view} that displays a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html WebLinkChart}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html Read more...} */ constructor(properties?: LinkChartViewProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html WebLinkChart} displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html#map Read more...} */ get map(): WebLinkChart | nullish; set map(value: WebLinkChartProperties | nullish); /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult hit test results} from each layer that intersects the specified screen coordinates. * * @param screenPoint The screen coordinates (or native mouse event) of the click on the view. * @param options Options to specify what is included in or excluded from the hitTest. Supported since 4.16. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html#hitTest Read more...} */ hitTest(screenPoint: MapViewScreenPoint | MouseEvent, options?: LinkChartViewHitTestOptions): Promise; } interface LinkChartViewProperties extends View2DProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html WebLinkChart} displayed in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html#map Read more...} */ map?: WebLinkChartProperties | nullish; } export interface LinkChartViewHitTestOptions { include?: HitTestItem | Iterable | Iterable>; exclude?: HitTestItem | Iterable | Iterable>; } export class Magnifier extends Accessor { /** * Controls the amount of magnification to display. * * @default 1.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#factor Read more...} */ factor: number; /** * Indicates whether the mask image is enabled. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#maskEnabled Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#maskUrl Read more...} */ maskUrl: string | nullish; /** * The offset of the magnifier in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#offset Read more...} */ offset: MagnifierScreenPoint; /** * Indicates whether the overlay image is enabled. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#overlayEnabled Read more...} */ overlayEnabled: boolean; /** * The overlay url points to an image that is displayed on top of the magnified image. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#overlayUrl Read more...} */ overlayUrl: string | nullish; /** * The position of the magnifier in pixels. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#position Read more...} */ position: MagnifierScreenPoint | nullish; /** * The size of the magnifier in pixels. * * @default 120 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#size Read more...} */ size: number; /** * Indicates whether the magnifier is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#visible Read more...} */ visible: boolean; /** * The Magnifier allows end users to show a portion of the view * as a magnified image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html Read more...} */ constructor(properties?: MagnifierProperties); } interface MagnifierProperties { /** * Controls the amount of magnification to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#factor Read more...} */ factor?: number; /** * Indicates whether the mask image is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#maskEnabled Read more...} */ 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). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#maskUrl Read more...} */ maskUrl?: string | nullish; /** * The offset of the magnifier in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#offset Read more...} */ offset?: MagnifierScreenPoint; /** * Indicates whether the overlay image is enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#overlayEnabled Read more...} */ overlayEnabled?: boolean; /** * The overlay url points to an image that is displayed on top of the magnified image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#overlayUrl Read more...} */ overlayUrl?: string | nullish; /** * The position of the magnifier in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#position Read more...} */ position?: MagnifierScreenPoint | nullish; /** * The size of the magnifier in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#size Read more...} */ size?: number; /** * Indicates whether the magnifier is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#visible Read more...} */ visible?: boolean; } /** * An object representing the location on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Magnifier.html#ScreenPoint Read more...} */ export interface MagnifierScreenPoint { x: number; y: number; } export class MapView extends View2D { /** * A MapView displays a 2D view of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html Read more...} */ constructor(properties?: MapViewProperties); /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult hit test results} from each layer that intersects the specified screen coordinates. * * @param screenPoint The screen coordinates (or native mouse event) of the click on the view. * @param options Options to specify what is included in or excluded from the hitTest. Supported since 4.16. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest Read more...} */ hitTest(screenPoint: MapViewScreenPoint | MouseEvent, options?: MapViewHitTestOptions): Promise; /** * Create a screenshot of the current view. * * @param options Screenshot options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#takeScreenshot Read more...} */ takeScreenshot(options?: MapViewTakeScreenshotOptions): Promise; } interface MapViewProperties extends View2DProperties { } export type MapViewEasingFunction = (t: number, duration: number) => number; /** * Animation options for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo goTo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#GoToOptions2D Read more...} */ export interface GoToOptions2D { animate?: boolean; animationMode?: "always" | "auto"; speedFactor?: number; duration?: number; maxDuration?: number; easing?: | "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | "cubic-in" | "cubic-out" | "cubic-in-out" | "expo-in" | "expo-out" | "expo-in-out" | "quad-in-out-coast" | "in-cubic" | "out-cubic" | "in-out-cubic" | "in-expo" | "out-expo" | "in-out-expo" | "in-out-coast-quad" | MapViewEasingFunction; pickClosestTarget?: boolean; signal?: AbortSignal | nullish; } /** * The target location/viewpoint to animate to in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo goTo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#GoToTarget2D Read more...} */ export type GoToTarget2D = | number[] | GeometryUnion | GeometryUnion[] | Collection | Graphic | Graphic[] | Collection | Viewpoint | any; /** * Object specification for the graphic hit result returned in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#GraphicHit Read more...} */ export interface MapViewGraphicHit { type: "graphic"; graphic: Graphic; layer: Layer | nullish; mapPoint: Point | nullish; } /** * A layer, graphic, or collection of layers or graphics to be used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} filter options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestItem Read more...} */ export type HitTestItem = Layer | Graphic | SubtypeSublayer; /** * Object specification for the result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult Read more...} */ export interface HitTestResult { results: MapViewViewHit[]; screenPoint: MapViewScreenPoint; } export interface MapViewHitTestOptions { include?: HitTestItem | Iterable | Iterable>; exclude?: HitTestItem | Iterable | Iterable>; } export interface MapViewTakeScreenshotOptions { format?: "jpg" | "png"; layers?: Layer[]; quality?: number; width?: number; height?: number; area?: MapViewTakeScreenshotOptionsArea; ignoreBackground?: boolean; ignorePadding?: boolean; } export interface MapViewTakeScreenshotOptionsArea { x: number; y: number; width: number; height: number; } /** * Object specification for the media hit results returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#MediaHit Read more...} */ export interface MapViewMediaHit { type: "media"; element: ImageElement | VideoElement; layer: MediaLayer; mapPoint: Point | nullish; sourcePoint: SourcePoint | nullish; } /** * Object specification for the route hit results returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#RouteHit Read more...} */ export interface MapViewRouteHit { type: "route"; layer: RouteLayer; mapPoint: Point | nullish; networkFeature: DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#ScreenPoint Read more...} */ export interface MapViewScreenPoint { x: number; y: number; } /** * Object returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#takeScreenshot takeScreenshot()} promise resolves:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#Screenshot Read more...} */ export interface Screenshot { dataUrl: string; data: ImageData; } /** * Options for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#toScreen toScreen()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#ToScreenOptions2D Read more...} */ export interface ToScreenOptions2D { pickClosestTarget?: boolean; } /** * Object specification for the result returned in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#ViewHit Read more...} */ export type MapViewViewHit = MapViewGraphicHit | MapViewMediaHit | MapViewRouteHit; export class gamepadGamepadSettings extends Accessor { /** * Whether gamepad navigation is enabled on the View. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#enabled Read more...} */ enabled: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. * * @default "pan" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#mode Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#tiltDirection Read more...} */ tiltDirection: "forward-down" | "forward-up"; /** * Gamepad navigation specific configuration settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html Read more...} */ constructor(properties?: gamepadGamepadSettingsProperties); /** * Use this property to explicitly select the gamepad device for map and scene navigation. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#device Read more...} */ get device(): GamepadInputDevice | nullish; set device(value: GamepadInputDeviceProperties | nullish); } interface gamepadGamepadSettingsProperties { /** * Use this property to explicitly select the gamepad device for map and scene navigation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#device Read more...} */ device?: GamepadInputDeviceProperties | nullish; /** * Whether gamepad navigation is enabled on the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#enabled Read more...} */ enabled?: boolean; /** * This setting controls the behavior of forward and back movement of the left stick. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#mode Read more...} */ mode?: "pan" | "zoom"; /** * Determines whether pressing the tilt axis forwards make the view tilt down (towards the nadir), or up (towards the zenith). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-gamepad-GamepadSettings.html#tiltDirection Read more...} */ tiltDirection?: "forward-down" | "forward-up"; } export class Navigation extends Accessor { /** * Indicates if single finger touch {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-drag drag} events are enabled or disabled. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#browserTouchPanEnabled Read more...} */ browserTouchPanEnabled: boolean; /** * When `true`, the view will temporarily continue to pan after the pointer (e.g. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#momentumEnabled Read more...} */ momentumEnabled: boolean; /** * Indicates whether the view can be zoomed in or out with the mouse wheel. * * @default true * @deprecated since version 4.32. Use {@link module:geoscene/views/navigation/NavigationActionMap#mouseWheel actionMap.mouseWheel} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#mouseWheelZoomEnabled Read more...} */ mouseWheelZoomEnabled: boolean; /** * Navigation related configuration settings on the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html Read more...} */ constructor(properties?: NavigationProperties); /** * The navigation action map defines the default behavior of the navigation controls. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#actionMap Read more...} */ get actionMap(): NavigationActionMap; set actionMap(value: NavigationActionMapProperties); /** * Gamepad navigation specific configuration settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#gamepad Read more...} */ get gamepad(): gamepadGamepadSettings; set gamepad(value: gamepadGamepadSettingsProperties); } interface NavigationProperties { /** * The navigation action map defines the default behavior of the navigation controls. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#actionMap Read more...} */ actionMap?: NavigationActionMapProperties; /** * Indicates if single finger touch {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-drag drag} events are enabled or disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#browserTouchPanEnabled Read more...} */ browserTouchPanEnabled?: boolean; /** * Gamepad navigation specific configuration settings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#gamepad Read more...} */ gamepad?: gamepadGamepadSettingsProperties; /** * When `true`, the view will temporarily continue to pan after the pointer (e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#momentumEnabled Read more...} */ momentumEnabled?: boolean; /** * Indicates whether the view can be zoomed in or out with the mouse wheel. * * @deprecated since version 4.32. Use {@link module:geoscene/views/navigation/NavigationActionMap#mouseWheel actionMap.mouseWheel} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-Navigation.html#mouseWheelZoomEnabled Read more...} */ mouseWheelZoomEnabled?: boolean; } export class NavigationActionMap extends Accessor { /** * The primary drag navigation action. * * @default "pan" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragPrimary Read more...} */ dragPrimary: DragAction; /** * The secondary drag navigation action. * * @default "rotate" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragSecondary Read more...} */ dragSecondary: DragAction; /** * The tertiary drag navigation action. * * @default "zoom" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragTertiary Read more...} */ dragTertiary: DragAction; /** * The mouse wheel zoom action. * * @default "zoom" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#mouseWheel Read more...} */ mouseWheel: "zoom" | "none"; /** * The navigation action map defines the default behavior of the navigation controls. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html Read more...} */ constructor(properties?: NavigationActionMapProperties); } interface NavigationActionMapProperties { /** * The primary drag navigation action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragPrimary Read more...} */ dragPrimary?: DragAction; /** * The secondary drag navigation action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragSecondary Read more...} */ dragSecondary?: DragAction; /** * The tertiary drag navigation action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#dragTertiary Read more...} */ dragTertiary?: DragAction; /** * The mouse wheel zoom action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#mouseWheel Read more...} */ mouseWheel?: "zoom" | "none"; } /** * Type of action to be performed when a drag gesture is performed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-navigation-NavigationActionMap.html#DragAction Read more...} */ export type DragAction = "pan" | "rotate" | "zoom" | "none"; export class PopupView { popupEnabled: boolean; get popup(): Popup | nullish; set popup(value: PopupProperties | nullish); /** * Closes the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-PopupView.html#closePopup Read more...} */ closePopup(): void; /** * Opens the popup at the given location with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the location and content of the popup when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-PopupView.html#openPopup Read more...} */ openPopup(options?: PopupViewOpenPopupOptions): Promise; } interface PopupViewProperties { popup?: PopupProperties | nullish; popupEnabled?: boolean; } export interface PopupViewOpenPopupOptions { title?: string; content?: string | HTMLElement | Widget; location?: Point; fetchFeatures?: boolean; features?: Graphic[]; promises?: Promise[]; featureMenuOpen?: boolean; updateLocationEnabled?: boolean; collapsed?: boolean; shouldFocus?: boolean; } export interface SceneView extends View, BreakpointsOwner, PopupView, DOMContainer { } export class SceneView { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#alphaCompositingEnabled Read more...} */ alphaCompositingEnabled: boolean; /** * A convenience property used for defining the breakpoints on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#height height} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#width width} of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#breakpoints Read more...} */ declare breakpoints: BreakpointsOwner["breakpoints"]; /** * Indicates if the browser focus is on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#focused Read more...} */ declare readonly focused: DOMContainer["focused"]; /** * The view for the ground of the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#groundView Read more...} */ readonly groundView: GroundView; /** * The height of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#height Read more...} */ declare readonly height: DOMContainer["height"]; /** * A convenience property indicating the general size of the view's height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#heightBreakpoint Read more...} */ declare heightBreakpoint: BreakpointsOwner["heightBreakpoint"]; /** * A convenience property indicating the view's orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#orientation Read more...} */ declare readonly orientation: BreakpointsOwner["orientation"]; /** * This property contains performance information in a SceneView like global memory usage and additional details for * layers about memory consumption and number of features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#performanceInfo Read more...} */ readonly performanceInfo: SceneViewPerformanceInfo; /** * Controls whether the popup opens when users click on the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#popupEnabled Read more...} */ declare popupEnabled: PopupView["popupEnabled"]; /** * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#qualityProfile Read more...} */ qualityProfile: "low" | "medium" | "high"; /** * Indicates if the view is being resized. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#resizing Read more...} */ declare readonly resizing: DOMContainer["resizing"]; /** * Represents an approximation of the map scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#scale Read more...} */ scale: number; /** * An array containing the width and height of the view in pixels, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#size Read more...} */ declare readonly size: DOMContainer["size"]; /** * Indicates if the view is visible on the page. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#suspended Read more...} */ declare readonly suspended: DOMContainer["suspended"]; /** * The tiling scheme information of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#tileInfo Read more...} */ readonly tileInfo: TileInfo | nullish; /** * The type of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#type Read more...} */ readonly type: "3d"; /** * The viewing mode (`local` or `global`). * * @default "global" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#viewingMode Read more...} */ viewingMode: "global" | "local"; /** * The visibleArea represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as * an instance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#visibleArea Read more...} */ readonly visibleArea: Polygon | nullish; /** * The width of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#width Read more...} */ declare readonly width: DOMContainer["width"]; /** * A convenience property indicating the general size of the view's width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#widthBreakpoint Read more...} */ declare widthBreakpoint: BreakpointsOwner["widthBreakpoint"]; /** * Represents the level of detail (LOD) at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#zoom Read more...} */ zoom: number; /** * A SceneView displays a 3D view of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene} * instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html Read more...} */ constructor(properties?: SceneViewProperties); /** * Allows for adding analyses directly to the default analyses in the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#analyses Read more...} */ get analyses(): Collection; set analyses(value: CollectionProperties); /** * The observation point from which the visible portion (or perspective) of the SceneView is determined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#camera Read more...} */ get camera(): Camera; set camera(value: CameraProperties); /** * Represents the view's center point; when setting the center you may pass a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} instance or an array of numbers representing * at longitude/latitude pair (`[-100.4593, 36.9014]`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#center Read more...} */ get center(): Point; set center(value: PointProperties | number[]); /** * Represents an optional clipping area used to define the visible {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} of * a local scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#clippingArea Read more...} */ get clippingArea(): Extent | nullish; set clippingArea(value: ExtentProperties | nullish); /** * Specifies constraints for [Camera tilt](geoscene-Camera.html#tilt) and altitude that may be applied to the SceneView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#constraints Read more...} */ get constraints(): SceneViewConstraints; set constraints(value: SceneViewConstraintsProperties); /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#container Read more...} */ get container(): HTMLDivElement | nullish; set container(value: HTMLDivElement | nullish | string); /** * Specifies various properties of the environment's visualization in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#environment Read more...} */ get environment(): SceneViewEnvironment; set environment(value: SceneViewEnvironmentProperties); /** * The extent represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as * an instance of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#extent Read more...} */ get extent(): Extent; set extent(value: ExtentProperties); /** * Applies a display filter on the view for a specific set of floor levels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#floors Read more...} */ get floors(): Collection; set floors(value: CollectionProperties); /** * Options for configuring the highlight. * * @deprecated since version 4.32. Use the [highlights](#highlights) property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions; set highlightOptions(value: HighlightOptionsProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} object that displays general content or attributes from * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#map map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#popup Read more...} */ get popup(): Popup | nullish; set popup(value: PopupProperties | nullish); /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#ui Read more...} */ get ui(): DefaultUI; set ui(value: DefaultUIProperties); /** * Represents the current view as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} * or point of observation on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#viewpoint Read more...} */ get viewpoint(): Viewpoint; set viewpoint(value: ViewpointProperties); /** * Closes the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#closePopup Read more...} */ closePopup(): void; /** * Sets the focus on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#focus Read more...} */ focus(): void; /** * Sets the view to a given target. * * @param target The target location/viewpoint to go to. When using an object for `target`, use the properties defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#GoToTarget3D GoToTarget3D}. * @param options View transition options. See the specification defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#GoToOptions3D GoToOptions3D} for more information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo Read more...} */ goTo(target: GoToTarget3D, options?: GoToOptions3D): Promise; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Returns {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult hit test results} from each layer that intersects the specified screen coordinates. * * @param screenPoint The screen coordinates (or native mouse event) of the click on the view. * @param options Intersection test options. By default the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#ground map.ground} is excluded if its opacity is smaller than one. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest Read more...} */ hitTest(screenPoint: SceneViewScreenPoint | MouseEvent, options?: SceneViewHitTestOptions): Promise; /** * Opens the popup at the given location with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the location and content of the popup when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#openPopup Read more...} */ openPopup(options?: PopupViewOpenPopupOptions): Promise; /** * Create a screenshot of the current view. * * @param options Screenshot options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#takeScreenshot Read more...} */ takeScreenshot(options?: SceneViewTakeScreenshotOptions): Promise; /** * Converts the given screen point to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html map point}. * * @param screenPoint The location on the screen (or native mouse event) to convert. * @param options Intersection test options. By default only the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#ground map.ground} and any {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMeshLayer.html IntegratedMeshLayer} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-IntegratedMesh3DTilesLayer.html IntegratedMesh3DTilesLayer} are included. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#toMap Read more...} */ toMap(screenPoint: SceneViewScreenPoint | MouseEvent, options?: SceneViewToMapOptions): Point | nullish; /** * Converts the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html map point} to a * screen point. * * @param point A point geometry. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#toScreen Read more...} */ toScreen(point: Point): SceneViewScreenPoint; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: LineOfSightAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: DirectLineMeasurementAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: AreaMeasurementAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: SliceAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: DimensionAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: ViewshedAnalysis): Promise; /** * Gets the analysis view created for the given analysis object. * * @param analysis The analysis for which to obtain the analysis view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#whenAnalysisView Read more...} */ whenAnalysisView(analysis: AnalysisUnion): Promise; } interface SceneViewProperties extends ViewProperties, BreakpointsOwnerProperties, PopupViewProperties, DOMContainerProperties { /** * Allows the view to be partially or fully transparent when composited with the webpage elements behind it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#alphaCompositingEnabled Read more...} */ alphaCompositingEnabled?: boolean; /** * Allows for adding analyses directly to the default analyses in the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#analyses Read more...} */ analyses?: CollectionProperties; /** * A convenience property used for defining the breakpoints on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#height height} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#width width} of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#breakpoints Read more...} */ breakpoints?: BreakpointsOwnerProperties["breakpoints"]; /** * The observation point from which the visible portion (or perspective) of the SceneView is determined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#camera Read more...} */ camera?: CameraProperties; /** * Represents the view's center point; when setting the center you may pass a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} instance or an array of numbers representing * at longitude/latitude pair (`[-100.4593, 36.9014]`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#center Read more...} */ center?: PointProperties | number[]; /** * Represents an optional clipping area used to define the visible {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html extent} of * a local scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#clippingArea Read more...} */ clippingArea?: ExtentProperties | nullish; /** * Specifies constraints for [Camera tilt](geoscene-Camera.html#tilt) and altitude that may be applied to the SceneView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#constraints Read more...} */ constraints?: SceneViewConstraintsProperties; /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#container Read more...} */ container?: HTMLDivElement | nullish | string; /** * Specifies various properties of the environment's visualization in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#environment Read more...} */ environment?: SceneViewEnvironmentProperties; /** * The extent represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as * an instance of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#extent Read more...} */ extent?: ExtentProperties; /** * Applies a display filter on the view for a specific set of floor levels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#floors Read more...} */ floors?: CollectionProperties; /** * A convenience property indicating the general size of the view's height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#heightBreakpoint Read more...} */ heightBreakpoint?: BreakpointsOwnerProperties["heightBreakpoint"]; /** * Options for configuring the highlight. * * @deprecated since version 4.32. Use the [highlights](#highlights) property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} object that displays general content or attributes from * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#map map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#popup Read more...} */ popup?: PopupProperties | nullish; /** * Controls whether the popup opens when users click on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#popupEnabled Read more...} */ popupEnabled?: PopupViewProperties["popupEnabled"]; /** * SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#qualityProfile Read more...} */ qualityProfile?: "low" | "medium" | "high"; /** * Represents an approximation of the map scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#scale Read more...} */ scale?: number; /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#ui Read more...} */ ui?: DefaultUIProperties; /** * The viewing mode (`local` or `global`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#viewingMode Read more...} */ viewingMode?: "global" | "local"; /** * Represents the current view as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} * or point of observation on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties; /** * A convenience property indicating the general size of the view's width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#widthBreakpoint Read more...} */ widthBreakpoint?: BreakpointsOwnerProperties["widthBreakpoint"]; /** * Represents the level of detail (LOD) at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#zoom Read more...} */ zoom?: number; } export type EasingFunction = (t: number, duration: number) => number; /** * Animation options for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo goTo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#GoToOptions3D Read more...} */ export interface GoToOptions3D { animate?: boolean; speedFactor?: number; duration?: number; maxDuration?: number; easing?: | "linear" | "cubic-in" | "cubic-out" | "cubic-in-out" | "expo-in" | "expo-out" | "expo-in-out" | "quad-in-out-coast" | "in-cubic" | "out-cubic" | "in-out-cubic" | "in-expo" | "out-expo" | "in-out-expo" | "in-out-coast-quad" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | EasingFunction; signal?: AbortSignal | nullish; } /** * The target location/viewpoint to animate to in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo goTo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#GoToTarget3D Read more...} */ export type GoToTarget3D = | number[] | GeometryUnion | GeometryUnion[] | Collection | Graphic | Graphic[] | Collection | Camera | Viewpoint | any; /** * Object specification for the graphic hit result returned in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#GraphicHit Read more...} */ export interface GraphicHit { type: "graphic"; graphic: Graphic; distance: number; layer: Layer | nullish; mapPoint: Point | nullish; } /** * Object specification for the result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult Read more...} */ export interface SceneViewHitTestResult { results: ViewHit[]; ground: HitTestResultGround; screenPoint: SceneViewScreenPoint | MouseEvent; } /** * A layer or graphic to be used in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#toMap toMap} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest} filter options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#IntersectItem Read more...} */ export type IntersectItem = Graphic | Layer | BuildingSublayer | SubtypeSublayer | Ground; /** * Object specification for the media hit results returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MediaLayer.html MediaLayer} in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#MediaHit Read more...} */ export interface MediaHit { type: "media"; element: ImageElement | VideoElement; distance: number; layer: MediaLayer; mapPoint: Point | nullish; sourcePoint: SourcePoint | nullish; } /** * Object specification for the route hit results returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#RouteHit Read more...} */ export interface RouteHit { type: "route"; layer: RouteLayer; mapPoint: Point; networkFeature: DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop; } export interface SceneViewConstraintsProperties { altitude?: SceneViewConstraintsAltitudeProperties; clipDistance?: SceneViewConstraintsClipDistanceProperties; tilt?: SceneViewConstraintsTiltProperties; } export interface SceneViewConstraints extends AnonymousAccessor { get altitude(): SceneViewConstraintsAltitude; set altitude(value: SceneViewConstraintsAltitudeProperties); get clipDistance(): SceneViewConstraintsClipDistance; set clipDistance(value: SceneViewConstraintsClipDistanceProperties); get tilt(): SceneViewConstraintsTilt; set tilt(value: SceneViewConstraintsTiltProperties); } export interface SceneViewConstraintsAltitudeProperties { min?: number; max?: number; } export interface SceneViewConstraintsAltitude extends AnonymousAccessor { min: number; max: number; } export interface SceneViewConstraintsClipDistanceProperties { near?: number; far?: number; mode?: "auto" | "manual"; } export interface SceneViewConstraintsClipDistance extends AnonymousAccessor { near: number; far: number; mode: "auto" | "manual"; } export interface SceneViewConstraintsTiltProperties { max?: number; mode?: "auto" | "manual"; } export interface SceneViewConstraintsTilt extends AnonymousAccessor { max: number; mode: "auto" | "manual"; } export interface SceneViewEnvironmentProperties { background?: BackgroundProperties | nullish; lighting?: (SunLightingProperties & { type?: "sun" }) | (VirtualLightingProperties & { type: "virtual" }); atmosphereEnabled?: boolean; weather?: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" }); weatherAvailable?: boolean; starsEnabled?: boolean; } export interface SceneViewEnvironment extends AnonymousAccessor { get background(): Background | nullish; set background(value: BackgroundProperties | nullish); get lighting(): SunLighting | VirtualLighting; set lighting(value: (SunLightingProperties & { type?: "sun" }) | (VirtualLightingProperties & { type: "virtual" })); get weather(): SunnyWeather | CloudyWeather | RainyWeather | SnowyWeather | FoggyWeather; set weather(value: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" })); atmosphereEnabled: boolean; weatherAvailable: boolean; starsEnabled: boolean; } export interface SceneViewHitTestOptions { include?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; exclude?: | (IntersectItem | Collection | IntersectItem[] | Ground)[] | Collection | IntersectItem; } export interface SceneViewTakeScreenshotOptions { format?: "jpg" | "png"; quality?: number; width?: number; height?: number; area?: SceneViewTakeScreenshotOptionsArea; ignorePadding?: boolean; } export interface SceneViewTakeScreenshotOptionsArea { x: number; y: number; width: number; height: number; } export interface SceneViewToMapOptions { include?: IntersectItem | Iterable | Iterable>; exclude?: IntersectItem | Iterable | Iterable>; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#ScreenPoint Read more...} */ export interface SceneViewScreenPoint { x: number; y: number; } /** * Object returned when {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#takeScreenshot takeScreenshot()} promise resolves:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#Screenshot Read more...} */ export interface SceneViewScreenshot { dataUrl: string; data: ImageData; } /** * Object specification for the result returned in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#HitTestResult HitTestResult} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#hitTest hitTest()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#ViewHit Read more...} */ export type ViewHit = GraphicHit | MediaHit | RouteHit; export interface HitTestResultGround { mapPoint: Point; distance: number; } /** * Contains utilities for working with colors in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-colorUtils.html Read more...} */ interface colorUtils { /** * Returns the average color of the view's background within the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#extent extent}. * * @param view The view instance from which to calculate the average color of the background. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-colorUtils.html#getBackgroundColor Read more...} */ 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. * * @param view The MapView instance from which to get the background color theme. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-colorUtils.html#getBackgroundColorTheme Read more...} */ getBackgroundColorTheme(view: MapView | SceneView): Promise<"light" | "dark" | nullish>; } export const colorUtils: colorUtils; export class HighlightOptions extends Accessor { /** * The opacity of the fill (area within the halo). * * @default 0.25 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#fillOpacity Read more...} */ fillOpacity: number; /** * The opacity of the highlight halo. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#haloOpacity Read more...} */ haloOpacity: number; /** * A name used to uniquely identify the highlight options within the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#name Read more...} */ name: string; /** * Defines the intensity of the shadow area obtained by overlapping the shadow of the highlighted feature and the * shadow of other objects in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * @default 0.2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowDifference Read more...} */ shadowDifference: number; /** * The opacity of the highlighted feature's shadow in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * @default 0.4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowOpacity Read more...} */ shadowOpacity: number; /** * HighlightOptions are used to customize the appearance of highlights applied to features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html Read more...} */ constructor(properties?: HighlightOptionsProperties); /** * The color of the highlight fill. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * The color of the halo surrounding the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#haloColor Read more...} */ get haloColor(): Color | nullish; set haloColor(value: ColorProperties | nullish); /** * The color of the highlighted feature's shadow in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * @default #000000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowColor Read more...} */ get shadowColor(): Color; set shadowColor(value: ColorProperties); } interface HighlightOptionsProperties { /** * The color of the highlight fill. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#color Read more...} */ color?: ColorProperties; /** * The opacity of the fill (area within the halo). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#fillOpacity Read more...} */ fillOpacity?: number; /** * The color of the halo surrounding the highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#haloColor Read more...} */ haloColor?: ColorProperties | nullish; /** * The opacity of the highlight halo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#haloOpacity Read more...} */ haloOpacity?: number; /** * A name used to uniquely identify the highlight options within the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights highlights} collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#name Read more...} */ name?: string; /** * The color of the highlighted feature's shadow in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowColor Read more...} */ shadowColor?: ColorProperties; /** * Defines the intensity of the shadow area obtained by overlapping the shadow of the highlighted feature and the * shadow of other objects in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowDifference Read more...} */ shadowDifference?: number; /** * The opacity of the highlighted feature's shadow in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html 3D SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html#shadowOpacity Read more...} */ shadowOpacity?: number; } export class Theme extends Accessor { /** * This class is used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} to define the base colors used by widgets and components * to render temporary graphics and labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Theme.html Read more...} */ constructor(properties?: ThemeProperties); /** * The base color used to render temporary graphics in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Theme.html#accentColor Read more...} */ get accentColor(): Color; set accentColor(value: ColorProperties); /** * The base color used to render temporary labels in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Theme.html#textColor Read more...} */ get textColor(): Color; set textColor(value: ColorProperties); } interface ThemeProperties { /** * The base color used to render temporary graphics in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Theme.html#accentColor Read more...} */ accentColor?: ColorProperties; /** * The base color used to render temporary labels in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-Theme.html#textColor Read more...} */ textColor?: ColorProperties; } export class DefaultUI extends UI { /** * An array of strings representing the default * widgets visible when a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-DefaultUI.html#components Read more...} */ components: string[]; /** * The DefaultUI class exposes the default * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html widget} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-DefaultUI.html#components components} available in either a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-DefaultUI.html Read more...} */ constructor(properties?: DefaultUIProperties); } interface DefaultUIProperties extends UIProperties { /** * An array of strings representing the default * widgets visible when a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-DefaultUI.html#components Read more...} */ components?: string[]; } export class UI extends Accessor { /** * The HTML Element that contains the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#container Read more...} */ container: HTMLElement | nullish; /** * The height of the UI container. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#height Read more...} */ readonly height: number; /** * Defines the padding for the UI from the top, left, right, and bottom sides * of the container or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * @default { left: 15, top: 15, right: 15, bottom: 15 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#padding Read more...} */ padding: any | number; /** * The view associated with the UI components. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#view Read more...} */ view: MapView | SceneView; /** * The width of the UI container. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#width Read more...} */ readonly width: number; /** * This class provides a simple interface for {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#add adding}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#move moving} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#remove removing} components from a view's user interface (UI). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html Read more...} */ constructor(properties?: UIProperties); /** * Adds one or more HTML component(s) or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html widgets} to the UI. * * @param component The component(s) to add to the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. Alternatively, you can pass an array of objects with the following specification. * @param position The position in the view at which to add the component. If not specified, `manual` is used by default. Using `manual` allows you to place the component in a container where you can position it anywhere using css. For the other possible values, "top", "bottom", "left", and "right" are consistent placements. The "leading" and "trailing" values depend on whether the browser is using right-to-left (RTL) or left-to-right (LTR). For LTR, "leading" is left and "trailing" is right. For RTL, "leading" is right and "trailing" is left. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#add Read more...} */ add(component: Widget | HTMLElement | string | any[] | UIAddComponent, position?: string | UIAddPosition): void; /** * Removes all components from a given position. * * @param position The position in the view at which to add the component. If not specified, `manual` is used by default. Using `manual` allows you to place the component in a container where you can position it anywhere using css. For the other possible values, "top", "bottom", "left", and "right" are consistent placements. The "leading" and "trailing" values depend on whether the browser is using right-to-left (RTL) or left-to-right (LTR). For LTR, "leading" is left and "trailing" is right. For RTL, "leading" is right and "trailing" is left. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#empty Read more...} */ 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. * * @param id The component's ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#find Read more...} */ find(id: string): HTMLElement | Widget | nullish; /** * Returns all widgets and/or HTML elements in the view, or only components at specified positions in the view. * * @param position The position or array of positions from which to fetch the components. If not specified, all components will be returned from the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#getComponents Read more...} */ getComponents(position?: UIPosition | UIPosition[]): (Widget | HTMLElement)[]; /** * Moves one or more UI component(s) to the specified position. * * @param component The component(s) to move. This value can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. Alternatively, you can pass an array of objects with the following specification. * @param position The destination position. The component will be placed in the UI {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#container container} when not provided. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#move Read more...} */ move(component: Widget | HTMLElement | string | any[] | UIMoveComponent, position?: string | UIMovePosition): void; /** * Removes one or more HTML component(s) or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html widgets} from the UI. * * @param component The component(s) to remove from the UI. This can be a widget instance, HTML element, a string value representing a DOM node ID, or an array containing a combination of any of those types. See the example snippets below for code examples. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#remove Read more...} */ remove(component: Widget | HTMLElement | string | any[]): void; } interface UIProperties { /** * The HTML Element that contains the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#container Read more...} */ container?: HTMLElement | nullish; /** * Defines the padding for the UI from the top, left, right, and bottom sides * of the container or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#padding Read more...} */ padding?: any | number; /** * The view associated with the UI components. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#view Read more...} */ view?: MapView | SceneView; } export interface UIAddComponent { component: Widget | HTMLElement | string; position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; index?: number; } export interface UIAddPosition { position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; index?: number; } export interface UIMoveComponent { component: Widget | HTMLElement | string; position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; index?: number; } export interface UIMovePosition { position?: | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; index?: number; } /** * The UI position of an element in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ui-UI.html#UIPosition Read more...} */ export type UIPosition = | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "top-leading" | "top-left" | "top-right" | "top-trailing" | "manual"; export interface VideoView extends Accessor, corePromise, Evented, DOMContainer { } export class VideoView { /** * Indicates if the browser focus is on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#focused Read more...} */ declare readonly focused: DOMContainer["focused"]; /** * The height of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#height Read more...} */ declare readonly height: DOMContainer["height"]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#layer Read more...} */ layer: VideoLayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#map Read more...} */ map: Map | WebMap | nullish; /** * When `true`, this property indicates whether the view successfully satisfied all dependencies, * signaling that the following conditions are met. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#ready Read more...} */ readonly ready: boolean; /** * Indicates if the view is being resized. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#resizing Read more...} */ declare readonly resizing: DOMContainer["resizing"]; /** * Scale is the ratio between the size of the video in pixels and the size of the view in pixels. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#scale Read more...} */ scale: number; /** * An array containing the width and height of the view in pixels, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#size Read more...} */ declare readonly size: DOMContainer["size"]; /** * Indicates if the view is visible on the page. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#suspended Read more...} */ declare readonly suspended: DOMContainer["suspended"]; /** * An array containing the width and height of the video in pixels, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#videoSize Read more...} */ readonly videoSize: number[]; /** * The width of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#width Read more...} */ declare readonly width: DOMContainer["width"]; /** * The VideoView class provides a view for displaying video feeds from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html Read more...} */ constructor(properties?: VideoViewProperties); /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#container Read more...} */ get container(): HTMLDivElement | nullish; set container(value: HTMLDivElement | nullish | string); /** * Options to configure the navigation behavior of the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#navigation Read more...} */ get navigation(): Navigation; set navigation(value: NavigationProperties); /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#ui Read more...} */ get ui(): DefaultUI; set ui(value: DefaultUIProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Sets the focus on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#focus Read more...} */ focus(): void; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#isResolved Read more...} */ isResolved(): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface VideoViewProperties extends DOMContainerProperties { /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#container Read more...} */ container?: HTMLDivElement | nullish | string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#layer Read more...} */ layer?: VideoLayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#map Read more...} */ map?: Map | WebMap | nullish; /** * Options to configure the navigation behavior of the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#navigation Read more...} */ navigation?: NavigationProperties; /** * Scale is the ratio between the size of the video in pixels and the size of the view in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#scale Read more...} */ scale?: number; /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-VideoView.html#ui Read more...} */ ui?: DefaultUIProperties; } export interface View extends Accessor, corePromise, Evented { } export class View { /** * Collection containing a flat list of all the created {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerViews} * related to the basemap, operational layers, and group layers in this view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#allLayerViews Read more...} */ readonly allLayerViews: Collection; /** * Represents an ongoing view animation initialized by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#goTo goTo()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#animation Read more...} */ animation: ViewAnimation | nullish; /** * Represents the view for a single basemap after it has been added to the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#basemapView Read more...} */ basemapView: BasemapView; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo displayFilters} are honored across all layers * in the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#displayFilterEnabled Read more...} */ displayFilterEnabled: boolean; /** * A fatal {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html error} returned * when the view loses its WebGL context. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#fatalError Read more...} */ fatalError: Error | nullish; /** * Options to configure input handling of the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#input Read more...} */ readonly input: Input; /** * Indication whether the view is being interacted with (for example when panning or by an interactive tool). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#interacting Read more...} */ readonly interacting: boolean; /** * A collection containing a hierarchical list of all the created * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerViews} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers operational layers} in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#layerViews Read more...} */ readonly layerViews: Collection; /** * The magnifier allows for showing a portion of the view as a magnifier image on top of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#magnifier Read more...} */ readonly magnifier: Magnifier; /** * Indication whether the view is being navigated (for example when panning). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#navigating Read more...} */ readonly navigating: boolean; /** * Use the padding property to make the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#center center}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#extent extent}, etc. * * @default {left: 0, top: 0, right: 0, bottom: 0} * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#padding Read more...} */ padding: ViewPadding; /** * When `true`, this property indicates whether the view successfully satisfied all dependencies, * signaling that the following conditions are met. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#ready Read more...} */ readonly ready: boolean; /** * Provides more granular information about the view's process of becoming ready. * * @default "loading" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#readyState Read more...} */ readonly readyState: | "loading" | "missing-map" | "missing-container" | "empty-map" | "map-content-error" | "rendering-error" | "ready"; /** * Represents the current value of one pixel in the unit of the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#spatialReference spatialReference}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#resolution Read more...} */ readonly resolution: number; /** * Indication whether the view is animating, being navigated with or resizing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#stationary Read more...} */ readonly stationary: boolean; /** * The type of the view is either `2d` (indicating a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}) or `3d` * (indicating a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#type Read more...} */ readonly type: string; /** * Indicates whether the view is being updated by additional data requests to the network, * or by processing received data. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#updating Read more...} */ readonly updating: boolean; /** * Contains the collection of active views on the page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#views Read more...} */ static readonly views: Collection; /** * A view provides the means of viewing and interacting with the components of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html Read more...} */ constructor(properties?: ViewProperties); /** * Allows for adding {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} directly to the default graphics in the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#graphics Read more...} */ get graphics(): Collection; set graphics(value: CollectionProperties); /** * Represents a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} objects which can be used to * highlight features throughout an application. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights Read more...} */ get highlights(): Collection; set highlights(value: CollectionProperties); /** * An instance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} object to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#map Read more...} */ get map(): Map | nullish; set map(value: MapProperties | nullish); /** * Options to configure the navigation behavior of the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#navigation Read more...} */ get navigation(): Navigation; set navigation(value: NavigationProperties); /** * The spatial reference of the view. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); /** * This property specifies the base colors used by some widgets and components to render graphics and labels. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#theme Read more...} */ get theme(): Theme | nullish; set theme(value: ThemeProperties | nullish); /** * The view's time extent. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Destroys the view, and any associated resources, including its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#map map}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#popup popup}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#ui UI} elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#destroy Read more...} */ destroy(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#isResolved Read more...} */ isResolved(): boolean; /** * Call this method to clear any {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#fatalError fatal errors} resulting from a lost WebGL context. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#tryFatalErrorRecovery Read more...} */ tryFatalErrorRecovery(): void; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: PointCloudLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: StreamLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: WFSLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: OGCFeatureLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: FeatureLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: CSVLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: GeoJSONLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: GeoRSSLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: GraphicsLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: ImageryLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: KMLLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: SceneLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: DimensionLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: MediaLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: ViewshedLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ whenLayerView(layer: LineOfSightLayer): Promise; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} created * on the view for the given layer. * * @param layer The layer for which to obtain its LayerView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#whenLayerView Read more...} */ 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: "analysis-view-create", eventHandler: ViewAnalysisViewCreateEventHandler): IHandle; on(name: "analysis-view-create-error", eventHandler: ViewAnalysisViewCreateErrorEventHandler): IHandle; on(name: "analysis-view-destroy", eventHandler: ViewAnalysisViewDestroyEventHandler): 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 { /** * Represents an ongoing view animation initialized by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#goTo goTo()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#animation Read more...} */ animation?: ViewAnimation | nullish; /** * Represents the view for a single basemap after it has been added to the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#basemapView Read more...} */ basemapView?: BasemapView; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#displayFilterInfo displayFilters} are honored across all layers * in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#displayFilterEnabled Read more...} */ displayFilterEnabled?: boolean; /** * A fatal {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html error} returned * when the view loses its WebGL context. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#fatalError Read more...} */ fatalError?: Error | nullish; /** * Allows for adding {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} directly to the default graphics in the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#graphics Read more...} */ graphics?: CollectionProperties; /** * Represents a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-support-HighlightOptions.html HighlightOptions} objects which can be used to * highlight features throughout an application. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#highlights Read more...} */ highlights?: CollectionProperties; /** * An instance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} object to display in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#map Read more...} */ map?: MapProperties | nullish; /** * Options to configure the navigation behavior of the View. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#navigation Read more...} */ navigation?: NavigationProperties; /** * Use the padding property to make the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#center center}, * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#extent extent}, etc. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#padding Read more...} */ padding?: ViewPadding; /** * The spatial reference of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * This property specifies the base colors used by some widgets and components to render graphics and labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#theme Read more...} */ theme?: ThemeProperties | nullish; /** * The view's time extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; } export interface ViewAnalysisViewCreateErrorEvent { analysis: AnalysisUnion; error: Error; } export interface ViewAnalysisViewCreateEvent { analysis: AnalysisUnion; analysisView: AnalysisViewUnion; } export interface ViewAnalysisViewDestroyEvent { analysis: AnalysisUnion; analysisView: AnalysisViewUnion; } export interface ViewBlurEvent { defer: EventDefer; native: any; target: View; } export interface ViewClickEvent { button: number; buttons: 0 | 1 | 2; defer: EventDefer; mapPoint: Point; native: any; timestamp: number; type: "click"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-click Read more...} */ stopPropagation(): void; } export interface ViewDoubleClickEvent { button: number; buttons: 0 | 1 | 2; defer: EventDefer; mapPoint: Point; native: any; timestamp: number; type: "double-click"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-double-click Read more...} */ stopPropagation(): void; } export interface ViewDragEvent { action: "start" | "added" | "update" | "removed" | "end"; angle: number; button: 0 | 1 | 2; buttons: number; defer: EventDefer; native: any; origin: ViewDragEventOrigin; radius: number; timestamp: number; type: "drag"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-drag Read more...} */ stopPropagation(): void; } export type EventDefer = (operation: EventDeferredOperation) => Promise; export type EventDeferredOperation = () => Promise; export interface ViewFocusEvent { defer: EventDefer; native: any; target: View; } export interface ViewHoldEvent { button: 0 | 1 | 2; buttons: number; defer: EventDefer; mapPoint: Point; native: any; timestamp: number; type: "hold"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-hold Read more...} */ stopPropagation(): void; } export interface ViewImmediateClickEvent { button: 0 | 1 | 2; buttons: number; defer: EventDefer; mapPoint: Point; native: any; timestamp: number; type: "immediate-click"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-immediate-click Read more...} */ stopPropagation(): void; } export interface ViewImmediateDoubleClickEvent { button: 0 | 1 | 2; buttons: number; defer: EventDefer; mapPoint: Point; native: any; timestamp: number; type: "immediate-double-click"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-immediate-double-click Read more...} */ stopPropagation(): void; } export interface ViewKeyDownEvent { defer: EventDefer; key: string; native: any; repeat: boolean; timestamp: number; type: "key-down"; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-key-down Read more...} */ stopPropagation(): void; } export interface ViewKeyUpEvent { defer: EventDefer; key: string; native: any; timestamp: number; type: "key-up"; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-key-up Read more...} */ stopPropagation(): void; } export interface ViewLayerviewCreateErrorEvent { error: Error; layer: Layer; } export interface ViewLayerviewCreateEvent { layer: Layer; layerView: LayerView; } export interface ViewLayerviewDestroyEvent { layer: Layer; layerView: LayerView; } export interface ViewMouseWheelEvent { defer: EventDefer; deltaY: number; native: any; timestamp: number; type: "mouse-wheel"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-mouse-wheel Read more...} */ stopPropagation(): void; } export interface ViewPointerDownEvent { button: number; buttons: number; defer: EventDefer; native: any; pointerId: number; pointerType: "mouse" | "touch"; timestamp: number; type: "pointer-down"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-pointer-down Read more...} */ stopPropagation(): void; } export interface ViewPointerEnterEvent { button: number; buttons: number; defer: EventDefer; native: any; pointerId: number; pointerType: "mouse" | "touch"; timestamp: number; type: "pointer-enter"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-pointer-enter Read more...} */ stopPropagation(): void; } export interface ViewPointerLeaveEvent { button: number; buttons: number; defer: EventDefer; native: any; pointerId: number; pointerType: "mouse" | "touch"; timestamp: number; type: "pointer-leave"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-pointer-leave Read more...} */ stopPropagation(): void; } export interface ViewPointerMoveEvent { button: number; buttons: number; defer: EventDefer; native: any; pointerId: number; pointerType: "mouse" | "touch"; timestamp: number; type: "pointer-move"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-pointer-move Read more...} */ stopPropagation(): void; } export interface ViewPointerUpEvent { button: number; buttons: number; defer: EventDefer; native: any; pointerId: number; pointerType: "mouse" | "touch"; timestamp: number; type: "pointer-up"; x: number; y: number; /** * Prevents the event bubbling up the event chain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html#event-pointer-up Read more...} */ stopPropagation(): void; } export interface ViewResizeEvent { height: number; oldHeight: number; oldWidth: number; width: number; } export interface ViewPadding { left?: number; top?: number; right?: number; bottom?: number; } export interface View2D extends View, BreakpointsOwner, PopupView, DOMContainer { } export class View2D { /** * A convenience property used for defining the breakpoints on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#height height} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#width width} of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#breakpoints Read more...} */ declare breakpoints: BreakpointsOwner["breakpoints"]; /** * Indicates if the browser focus is on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#focused Read more...} */ declare readonly focused: DOMContainer["focused"]; /** * The height of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#height Read more...} */ declare readonly height: DOMContainer["height"]; /** * A convenience property indicating the general size of the view's height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#heightBreakpoint Read more...} */ declare heightBreakpoint: BreakpointsOwner["heightBreakpoint"]; /** * A convenience property indicating the view's orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#orientation Read more...} */ declare readonly orientation: BreakpointsOwner["orientation"]; /** * Controls whether the popup opens when users click on the view. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#popupEnabled Read more...} */ declare popupEnabled: PopupView["popupEnabled"]; /** * Defines which anchor stays still while resizing the browser window. * * @default "center" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#resizeAlign Read more...} */ resizeAlign: | "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"; /** * Indicates if the view is being resized. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#resizing Read more...} */ declare readonly resizing: DOMContainer["resizing"]; /** * The clockwise rotation of due north in relation to the top of the view in degrees. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#rotation Read more...} */ rotation: number; /** * Represents the map scale at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#scale Read more...} */ scale: number; /** * An array containing the width and height of the view in pixels, e.g. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#size Read more...} */ declare readonly size: DOMContainer["size"]; /** * Indicates if the MapView's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#spatialReference spatialReference} can be changed after it is initialized. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#spatialReferenceLocked Read more...} */ spatialReferenceLocked: boolean; /** * Indicates if the view is visible on the page. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#suspended Read more...} */ declare readonly suspended: DOMContainer["suspended"]; /** * The tiling scheme information of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#tileInfo Read more...} */ readonly tileInfo: TileInfo | nullish; /** * Defines the time zone of the view. * * @default "system" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#timeZone Read more...} */ timeZone: string; /** * The dimension of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#type Read more...} */ readonly type: "2d"; /** * The visibleArea represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as * an instance of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Polygon.html Polygon}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#visibleArea Read more...} */ readonly visibleArea: Polygon | nullish; /** * The width of the view in pixels read from the view container element. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#width Read more...} */ declare readonly width: DOMContainer["width"]; /** * A convenience property indicating the general size of the view's width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#widthBreakpoint Read more...} */ declare widthBreakpoint: BreakpointsOwner["widthBreakpoint"]; /** * Represents the level of detail (LOD) at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#zoom Read more...} */ zoom: number; /** * View2D is the base class for all 2D views. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html Read more...} */ constructor(properties?: View2DProperties); /** * The background color of the MapView. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#background Read more...} */ get background(): ColorBackground | nullish; set background(value: ColorBackgroundProperties | nullish); /** * Represents the view's center point; when setting the center, you may pass a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} instance or an array of numbers representing * a longitude/latitude pair (`[-100.4593, 36.9014]`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#center Read more...} */ get center(): Point; set center(value: PointProperties | number[]); /** * Specifies constraints to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#scale scale}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#zoom zoom}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#rotation rotation} that may be applied to the MapView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#constraints Read more...} */ get constraints(): View2DConstraints; set constraints(value: View2DConstraintsProperties); /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#container Read more...} */ get container(): HTMLDivElement | nullish; set container(value: HTMLDivElement | nullish | string); /** * The extent represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#extent Read more...} */ get extent(): Extent; set extent(value: ExtentProperties); /** * Applies a display filter on the view for a specific set of floor levels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#floors Read more...} */ get floors(): Collection; set floors(value: CollectionProperties); /** * Options for configuring the highlight. * * @deprecated since version 4.32. Use the [highlights](#highlights) property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#highlightOptions Read more...} */ get highlightOptions(): HighlightOptions; set highlightOptions(value: HighlightOptionsProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} object that displays general content or attributes from * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#map map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#popup Read more...} */ get popup(): Popup | nullish; set popup(value: PopupProperties | nullish); /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#ui Read more...} */ get ui(): DefaultUI; set ui(value: DefaultUIProperties); /** * Represents the current view as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} or point of observation on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#viewpoint Read more...} */ get viewpoint(): Viewpoint; set viewpoint(value: ViewpointProperties); /** * Closes the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#closePopup Read more...} */ closePopup(): void; /** * Sets the focus on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#focus Read more...} */ focus(): void; /** * Sets the view to a given target. * * @param target The target location/viewpoint to animate to. When using an object for `target`, use the properties in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#GoToTarget2D GoToTarget2D}. * @param options Animation options for controlling the duration and easing of the animation. See the properties defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#GoToOptions2D GoToOptions2D} for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#goTo Read more...} */ goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise; /** * Opens the popup at the given location with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the location and content of the popup when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#openPopup Read more...} */ openPopup(options?: PopupViewOpenPopupOptions): Promise; /** * Converts the given screen point to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html map point}. * * @param screenPoint The location on the screen (or native mouse event) to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#toMap Read more...} */ toMap(screenPoint: MapViewScreenPoint | MouseEvent): Point; /** * Converts the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html map point} to a screen point. * * @param point A point geometry. * @param options Options for controlling the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#toScreen toScreen()} calculation. See the properties defined in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#ToScreenOptions2D ToScreenOptions2D} for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#toScreen Read more...} */ toScreen(point: Point, options?: ToScreenOptions2D): MapViewScreenPoint | nullish; } interface View2DProperties extends ViewProperties, BreakpointsOwnerProperties, PopupViewProperties, DOMContainerProperties { /** * The background color of the MapView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#background Read more...} */ background?: ColorBackgroundProperties | nullish; /** * A convenience property used for defining the breakpoints on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#height height} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#width width} of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#breakpoints Read more...} */ breakpoints?: BreakpointsOwnerProperties["breakpoints"]; /** * Represents the view's center point; when setting the center, you may pass a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} instance or an array of numbers representing * a longitude/latitude pair (`[-100.4593, 36.9014]`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#center Read more...} */ center?: PointProperties | number[]; /** * Specifies constraints to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#scale scale}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#zoom zoom}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#rotation rotation} that may be applied to the MapView. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#constraints Read more...} */ constraints?: View2DConstraintsProperties; /** * The `id` or node representing the DOM element containing the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#container Read more...} */ container?: HTMLDivElement | nullish | string; /** * The extent represents the visible portion of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} within the view as an instance of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#extent Read more...} */ extent?: ExtentProperties; /** * Applies a display filter on the view for a specific set of floor levels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#floors Read more...} */ floors?: CollectionProperties; /** * A convenience property indicating the general size of the view's height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#heightBreakpoint Read more...} */ heightBreakpoint?: BreakpointsOwnerProperties["heightBreakpoint"]; /** * Options for configuring the highlight. * * @deprecated since version 4.32. Use the [highlights](#highlights) property instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#highlightOptions Read more...} */ highlightOptions?: HighlightOptionsProperties; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} object that displays general content or attributes from * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#layers layers} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#map map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#popup Read more...} */ popup?: PopupProperties | nullish; /** * Controls whether the popup opens when users click on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#popupEnabled Read more...} */ popupEnabled?: PopupViewProperties["popupEnabled"]; /** * Defines which anchor stays still while resizing the browser window. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#resizeAlign Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#rotation Read more...} */ rotation?: number; /** * Represents the map scale at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#scale Read more...} */ scale?: number; /** * Indicates if the MapView's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#spatialReference spatialReference} can be changed after it is initialized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#spatialReferenceLocked Read more...} */ spatialReferenceLocked?: boolean; /** * Defines the time zone of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#timeZone Read more...} */ timeZone?: string; /** * Exposes the default widgets available in the view and allows you to toggle them on * and off. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#ui Read more...} */ ui?: DefaultUIProperties; /** * Represents the current view as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} or point of observation on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties; /** * A convenience property indicating the general size of the view's width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#widthBreakpoint Read more...} */ widthBreakpoint?: BreakpointsOwnerProperties["widthBreakpoint"]; /** * Represents the level of detail (LOD) at the center of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View2D.html#zoom Read more...} */ zoom?: number; } export interface View2DConstraintsProperties { lods?: LODProperties[] | nullish; geometry?: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish; minScale?: number; maxScale?: number; minZoom?: number; maxZoom?: number; snapToZoom?: boolean; rotationEnabled?: boolean; effectiveLODs?: LOD[] | nullish; effectiveMinZoom?: number; effectiveMaxZoom?: number; effectiveMinScale?: number; effectiveMaxScale?: number; } export interface View2DConstraints extends AnonymousAccessor { get lods(): LOD[] | nullish; set lods(value: LODProperties[] | nullish); get geometry(): Extent | Polygon | nullish; set geometry(value: (ExtentProperties & { type: "extent" }) | (PolygonProperties & { type: "polygon" }) | nullish); minScale: number; maxScale: number; minZoom: number; maxZoom: number; snapToZoom: boolean; rotationEnabled: boolean; effectiveLODs: LOD[] | nullish; effectiveMinZoom: number; effectiveMaxZoom: number; effectiveMinScale: number; effectiveMaxScale: number; } export interface ViewAnimation extends Accessor, corePromise { } export class ViewAnimation { /** * The state of the animation. * * @default "running" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#state Read more...} */ readonly state: "running" | "finished" | "stopped" | "waiting-for-target"; /** * The target of the animation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#target Read more...} */ target: Viewpoint | Promise | nullish; /** * Contains a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#state state} property used for checking the state of the animation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html Read more...} */ constructor(properties?: ViewAnimationProperties); /** * Finishes the view animation by immediately going to the target and sets * the state of the animation to `finished`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#finish Read more...} */ finish(): void; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#isResolved Read more...} */ isResolved(): boolean; /** * Stops the view animation at its current state and sets the state of * the animation to `stopped`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#stop Read more...} */ stop(): void; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface ViewAnimationProperties { /** * The target of the animation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-ViewAnimation.html#target Read more...} */ target?: Viewpoint | Promise | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#addressSearchEnabled Read more...} */ addressSearchEnabled: boolean; /** * Whether search functionality is enabled in the web scene or the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#enabled Read more...} */ enabled: boolean; /** * The hint provided with the search dialog. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#hintText Read more...} */ hintText: string | nullish; /** * Represents the search parameters set within the web scene or the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html Read more...} */ constructor(properties?: SearchProperties); /** * A collection of layers to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties); /** * A collection of tables to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#tables Read more...} */ get tables(): Collection; set tables(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#clone Read more...} */ clone(): Search; } interface SearchProperties { /** * Indicates whether the place finder is enabled in the web scene or the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#addressSearchEnabled Read more...} */ addressSearchEnabled?: boolean; /** * Whether search functionality is enabled in the web scene or the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#enabled Read more...} */ enabled?: boolean; /** * The hint provided with the search dialog. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#hintText Read more...} */ hintText?: string | nullish; /** * A collection of layers to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#layers Read more...} */ layers?: CollectionProperties; /** * A collection of tables to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Search.html#tables Read more...} */ tables?: CollectionProperties; } export class SearchLayer extends Accessor { /** * The id of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#id Read more...} */ id: string; /** * The sub layer index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#subLayer Read more...} */ subLayer: number | nullish; /** * Represents a layer to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html Read more...} */ constructor(properties?: SearchLayerProperties); /** * The field to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#field Read more...} */ get field(): SearchLayerField; set field(value: SearchLayerFieldProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#clone Read more...} */ clone(): SearchLayer; } interface SearchLayerProperties { /** * The field to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#field Read more...} */ field?: SearchLayerFieldProperties; /** * The id of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#id Read more...} */ id?: string; /** * The sub layer index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayer.html#subLayer Read more...} */ subLayer?: number | nullish; } export class SearchLayerField extends Accessor { /** * Whether or not the field is an exact match. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#exactMatch Read more...} */ exactMatch: boolean; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#name Read more...} */ name: string | nullish; /** * The data type of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#type Read more...} */ type: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" | "big-integer" | "date-only" | "time-only" | "timestamp-offset" | nullish; /** * Represents the field of a layer to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html Read more...} */ constructor(properties?: SearchLayerFieldProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#clone Read more...} */ clone(): SearchLayerField; } interface SearchLayerFieldProperties { /** * Whether or not the field is an exact match. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#exactMatch Read more...} */ exactMatch?: boolean; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#name Read more...} */ name?: string | nullish; /** * The data type of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchLayerField.html#type Read more...} */ type?: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" | "big-integer" | "date-only" | "time-only" | "timestamp-offset" | nullish; } export class SearchTable extends Accessor { /** * The id of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html#id Read more...} */ id: string | nullish; /** * Represents a table to be included in search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html Read more...} */ constructor(properties?: SearchTableProperties); /** * The field to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html#field Read more...} */ get field(): SearchTableField | nullish; set field(value: SearchTableFieldProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html#clone Read more...} */ clone(): SearchTable; } interface SearchTableProperties { /** * The field to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html#field Read more...} */ field?: SearchTableFieldProperties | nullish; /** * The id of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html#id Read more...} */ id?: string | nullish; } export class SearchTableField extends Accessor { /** * Whether or not the field is an exact match. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#exactMatch Read more...} */ exactMatch: boolean; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#name Read more...} */ name: string | nullish; /** * The data type of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#type Read more...} */ type: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" | "big-integer" | "date-only" | "time-only" | "timestamp-offset" | nullish; /** * Represents the field of a table to use for search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html Read more...} */ constructor(properties?: SearchTableFieldProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#clone Read more...} */ clone(): SearchTableField; } interface SearchTableFieldProperties { /** * Whether or not the field is an exact match. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#exactMatch Read more...} */ exactMatch?: boolean; /** * The name of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#name Read more...} */ name?: string | nullish; /** * The data type of the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTableField.html#type Read more...} */ type?: | "small-integer" | "integer" | "single" | "double" | "long" | "string" | "date" | "oid" | "geometry" | "blob" | "raster" | "guid" | "global-id" | "xml" | "big-integer" | "date-only" | "time-only" | "timestamp-offset" | nullish; } export class Viewing extends Accessor { /** * Represents view-specific properties of application and UI elements for the web map or web scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Viewing.html Read more...} */ constructor(properties?: ViewingProperties); /** * An object specifying the search parameters set within the web scene or web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Viewing.html#search Read more...} */ get search(): Search | nullish; set search(value: SearchProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Viewing.html#clone Read more...} */ clone(): Viewing; } interface ViewingProperties { /** * An object specifying the search parameters set within the web scene or web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-Viewing.html#search Read more...} */ search?: SearchProperties | nullish; } export interface GeotriggersInfo extends Accessor, JSONSupport, Clonable { } export class GeotriggersInfo { /** * Information relating to a list of Geotriggers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html Read more...} */ constructor(properties?: GeotriggersInfoProperties); /** * A list of Geotriggers. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html#geotriggers Read more...} */ get geotriggers(): Geotrigger[] | nullish; set geotriggers(value: (GeotriggerProperties & { type: "fence" }[]) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GeotriggersInfo; } interface GeotriggersInfoProperties { /** * A list of Geotriggers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-GeotriggersInfo.html#geotriggers Read more...} */ geotriggers?: (GeotriggerProperties & { type: "fence" }[]) | nullish; } export interface DeviceLocationFeed extends Accessor, JSONSupport, Clonable { } export class DeviceLocationFeed { /** * String indicating the type of Geotrigger feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#type Read more...} */ readonly type: "device-location"; /** * A Geotrigger feed which uses the device location to provide updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html Read more...} */ constructor(properties?: DeviceLocationFeedProperties); /** * An optional Arcade expression that controls whether a location update will be used by a geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#filterExpression Read more...} */ get filterExpression(): geotriggersInfoExpressionInfo | nullish; set filterExpression(value: geotriggersInfoExpressionInfoProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): DeviceLocationFeed; } interface DeviceLocationFeedProperties { /** * An optional Arcade expression that controls whether a location update will be used by a geotrigger. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-DeviceLocationFeed.html#filterExpression Read more...} */ filterExpression?: geotriggersInfoExpressionInfoProperties | nullish; } export interface geotriggersInfoExpressionInfo extends Accessor, JSONSupport, Clonable { } export class geotriggersInfoExpressionInfo { /** * Optional expression in the [Arcade expression](https://doc.geoscene.cn/arcade/) language. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#expression Read more...} */ expression: string | nullish; /** * Optional return type of the Arcade expression. * * @default "string" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#returnType Read more...} */ returnType: "number" | "string"; /** * Optional title of the expression. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#title Read more...} */ title: string | nullish; /** * Defines a script expression that can be used to compute values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html Read more...} */ constructor(properties?: geotriggersInfoExpressionInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): geotriggersInfoExpressionInfo; } interface geotriggersInfoExpressionInfoProperties { /** * Optional expression in the [Arcade expression](https://doc.geoscene.cn/arcade/) language. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#expression Read more...} */ expression?: string | nullish; /** * Optional return type of the Arcade expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#returnType Read more...} */ returnType?: "number" | "string"; /** * Optional title of the expression. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-ExpressionInfo.html#title Read more...} */ title?: string | nullish; } export interface FeatureFenceParameters extends Accessor, JSONSupport, Clonable { } export class FeatureFenceParameters { /** * An optional buffer distance to apply to fence features in meters. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#bufferDistance Read more...} */ bufferDistance: number | nullish; /** * String indicating the fence parameters type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#type Read more...} */ readonly type: "features"; /** * Fence parameters for a Geotrigger that uses feature data from an online feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html Read more...} */ constructor(properties?: FeatureFenceParametersProperties); /** * An object defining the source for a feature layer to be used as fences. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#fenceSource Read more...} */ get fenceSource(): FeatureLayerSource | nullish; set fenceSource(value: FeatureLayerSourceProperties | nullish); /** * An optional filter to reduce the features used for the parameters. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#filter Read more...} */ get filter(): geotriggersInfoFeatureFilter | nullish; set filter(value: geotriggersInfoFeatureFilterProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureFenceParameters; } interface FeatureFenceParametersProperties { /** * An optional buffer distance to apply to fence features in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#bufferDistance Read more...} */ bufferDistance?: number | nullish; /** * An object defining the source for a feature layer to be used as fences. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#fenceSource Read more...} */ fenceSource?: FeatureLayerSourceProperties | nullish; /** * An optional filter to reduce the features used for the parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFenceParameters.html#filter Read more...} */ filter?: geotriggersInfoFeatureFilterProperties | nullish; } export interface geotriggersInfoFeatureFilter extends Accessor, JSONSupport, Clonable { } export class geotriggersInfoFeatureFilter { /** * An optional SQL-based definition expression string that narrows the data to be used. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#where Read more...} */ where: string | nullish; /** * Description of spatial and attribute filters that will be applied to Feature data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html Read more...} */ constructor(properties?: geotriggersInfoFeatureFilterProperties); /** * An optional geometry used to filter the features from a feature table. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#geometry Read more...} */ get geometry(): GeometryUnion | nullish; set geometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): geotriggersInfoFeatureFilter; } interface geotriggersInfoFeatureFilterProperties { /** * An optional geometry used to filter the features from a feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#geometry Read more...} */ geometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * An optional SQL-based definition expression string that narrows the data to be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureFilter.html#where Read more...} */ where?: string | nullish; } 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#layerId Read more...} */ layerId: string | nullish; /** * A URL to a service that will be used for all queries against the layer. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#layerUrl Read more...} */ layerUrl: string | nullish; /** * String indicating the type of source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#type Read more...} */ readonly type: "feature-layer"; /** * The source for a feature layer to be used as fences for Geotriggers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html Read more...} */ constructor(properties?: FeatureLayerSourceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#layerId Read more...} */ layerId?: string | nullish; /** * A URL to a service that will be used for all queries against the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FeatureLayerSource.html#layerUrl Read more...} */ layerUrl?: string | nullish; } 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#enterExitRule Read more...} */ enterExitRule: | "enter-contains-and-exit-does-not-contain" | "enter-contains-and-exit-does-not-intersect" | "enter-intersects-and-exit-does-not-intersect"; /** * Indicates how the geotrigger will use accuracy information from a feed. * * @default "use-geometry" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#feedAccuracyMode Read more...} */ feedAccuracyMode: "use-geometry" | "use-geometry-with-accuracy"; /** * Indicates the type of event that will trigger notifications for the Fence Geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceNotificationRule Read more...} */ fenceNotificationRule: "enter" | "enter-or-exit" | "exit" | nullish; /** * The name for this Geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#name Read more...} */ name: string | nullish; /** * A condition which monitors the dynamic elements of the geotrigger feed for enter/exit against the fences defined by the Fence Parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html Read more...} */ constructor(properties?: FenceGeotriggerProperties); /** * The feed for this Geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#feed Read more...} */ get feed(): DeviceLocationFeed | nullish; set feed(value: DeviceLocationFeedProperties | nullish); /** * An object defining the fences to use for this Geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceParameters Read more...} */ get fenceParameters(): FeatureFenceParameters | nullish; set fenceParameters(value: FeatureFenceParametersProperties | nullish); /** * Options that control the notification information sent to a client app when a Geotrigger condition is met. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#notificationOptions Read more...} */ get notificationOptions(): GeotriggerNotificationOptions | nullish; set notificationOptions(value: GeotriggerNotificationOptionsProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#enterExitRule Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#feed Read more...} */ feed?: DeviceLocationFeedProperties | nullish; /** * Indicates how the geotrigger will use accuracy information from a feed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#feedAccuracyMode Read more...} */ feedAccuracyMode?: "use-geometry" | "use-geometry-with-accuracy"; /** * Indicates the type of event that will trigger notifications for the Fence Geotrigger. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceNotificationRule Read more...} */ fenceNotificationRule?: "enter" | "enter-or-exit" | "exit" | nullish; /** * An object defining the fences to use for this Geotrigger. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#fenceParameters Read more...} */ fenceParameters?: FeatureFenceParametersProperties | nullish; /** * The name for this Geotrigger. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#name Read more...} */ name?: string | nullish; /** * Options that control the notification information sent to a client app when a Geotrigger condition is met. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-FenceGeotrigger.html#notificationOptions Read more...} */ notificationOptions?: GeotriggerNotificationOptionsProperties | nullish; } export interface Geotrigger extends Accessor, JSONSupport, Clonable { } export class Geotrigger { /** * String indicating the Geotrigger condition type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-Geotrigger.html#type Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-Geotrigger.html Read more...} */ constructor(properties?: GeotriggerProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-Geotrigger.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-Geotrigger.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-Geotrigger.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Geotrigger; } interface GeotriggerProperties { } export interface GeotriggerNotificationOptions extends Accessor, JSONSupport, Clonable { } export class GeotriggerNotificationOptions { /** * An optional list of strings indicating the set of possible actions resulting from this Geotrigger. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#requestedActions Read more...} */ requestedActions: string[] | nullish; /** * Options that control the notification information sent to a client app client when a Geotrigger condition is met. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html Read more...} */ constructor(properties?: GeotriggerNotificationOptionsProperties); /** * An optional Arcade expression which can be used to configure notification information when the Geotrigger condition is met. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#expressionInfo Read more...} */ get expressionInfo(): geotriggersInfoExpressionInfo | nullish; set expressionInfo(value: geotriggersInfoExpressionInfoProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#expressionInfo Read more...} */ expressionInfo?: geotriggersInfoExpressionInfoProperties | nullish; /** * An optional list of strings indicating the set of possible actions resulting from this Geotrigger. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-geotriggersInfo-GeotriggerNotificationOptions.html#requestedActions Read more...} */ requestedActions?: string[] | nullish; } export interface AppleIPSProperties extends Accessor, JSONSupport, Clonable { } export class AppleIPSProperties { /** * Property indicating whether Apple indoor Positioning is enabled or not. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html#enabled Read more...} */ enabled: boolean; /** * Defines the AppleIPS properties of Indoor Positioning Configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html Read more...} */ constructor(properties?: AppleIPSPropertiesProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): AppleIPSProperties; } interface AppleIPSPropertiesProperties { /** * Property indicating whether Apple indoor Positioning is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-AppleIPSProperties.html#enabled Read more...} */ enabled?: boolean; } export interface Configuration extends Accessor, Clonable, JSONSupport { } export class Configuration { /** * Defines the IPS Configuration settings for IPS-Aware Maps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html Read more...} */ constructor(properties?: ConfigurationProperties); /** * Property indicating whether appleIPS is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#appleIPS Read more...} */ get appleIPS(): AppleIPSProperties | nullish; set appleIPS(value: AppleIPSPropertiesProperties | nullish); /** * Property indicating whether GNSS is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#gnss Read more...} */ get gnss(): GNSSProperties | nullish; set gnss(value: GNSSPropertiesProperties | nullish); /** * Property indicating whether path snapping is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#pathSnapping Read more...} */ get pathSnapping(): PathSnappingProperties | nullish; set pathSnapping(value: PathSnappingPropertiesProperties | nullish); /** * Property indicating whether smoothing is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#smoothing Read more...} */ get smoothing(): SmoothingProperties | nullish; set smoothing(value: SmoothingPropertiesProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Configuration; } interface ConfigurationProperties { /** * Property indicating whether appleIPS is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#appleIPS Read more...} */ appleIPS?: AppleIPSPropertiesProperties | nullish; /** * Property indicating whether GNSS is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#gnss Read more...} */ gnss?: GNSSPropertiesProperties | nullish; /** * Property indicating whether path snapping is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#pathSnapping Read more...} */ pathSnapping?: PathSnappingPropertiesProperties | nullish; /** * Property indicating whether smoothing is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-Configuration.html#smoothing Read more...} */ smoothing?: SmoothingPropertiesProperties | nullish; } export interface GNSSProperties extends Accessor, JSONSupport, Clonable { } export class GNSSProperties { /** * Property indicating whether GNSS is enabled or not. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html#enabled Read more...} */ enabled: boolean; /** * Defines the GNSS properties of Indoor Positioning Configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html Read more...} */ constructor(properties?: GNSSPropertiesProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): GNSSProperties; } interface GNSSPropertiesProperties { /** * Property indicating whether GNSS is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-GNSSProperties.html#enabled Read more...} */ enabled?: boolean; } export interface PathSnappingProperties extends Accessor, JSONSupport, Clonable { } export class PathSnappingProperties { /** * Property indicating the distance set for path snapping. * * @default 5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#distance Read more...} */ distance: number; /** * Property indicating whether path snapping is enabled or not. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#enabled Read more...} */ enabled: boolean; /** * Property indicating the unit set for path snapping distance. * * @default "meter" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#units Read more...} */ units: "feet" | "meter"; /** * Defines the Path Snapping properties of Indoor Positioning Configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html Read more...} */ constructor(properties?: PathSnappingPropertiesProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PathSnappingProperties; } interface PathSnappingPropertiesProperties { /** * Property indicating the distance set for path snapping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#distance Read more...} */ distance?: number; /** * Property indicating whether path snapping is enabled or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#enabled Read more...} */ enabled?: boolean; /** * Property indicating the unit set for path snapping distance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PathSnappingProperties.html#units Read more...} */ units?: "feet" | "meter"; } export interface PositioningService extends Accessor, JSONSupport, Clonable { } export class PositioningService { /** * Provides indoor positioning data service information. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html Read more...} */ constructor(properties?: PositioningServiceProperties); /** * Feature Service item representing indoor positioning data service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): PositioningService; } interface PositioningServiceProperties { /** * Feature Service item representing indoor positioning data service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-PositioningService.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; } export interface SmoothingProperties extends Accessor, JSONSupport, Clonable { } export class SmoothingProperties { /** * Indicates whether smoothing is enabled for the IPS data. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html#enabled Read more...} */ enabled: boolean; /** * Defines the Smoothing properties of Indoor Positioning Configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html Read more...} */ constructor(properties?: SmoothingPropertiesProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SmoothingProperties; } interface SmoothingPropertiesProperties { /** * Indicates whether smoothing is enabled for the IPS data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-ips-SmoothingProperties.html#enabled Read more...} */ enabled?: boolean; } export interface IPSInfo extends Accessor, JSONSupport, Clonable { } export class IPSInfo { /** * The indoor positioning system (IPS) information for a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html Read more...} */ constructor(properties?: IPSInfoProperties); /** * Defines the configuration properties for Indoor Positioning Data Service. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#configuration Read more...} */ get configuration(): Configuration | nullish; set configuration(value: ConfigurationProperties | nullish); /** * Defines the portal item for the positioning data service. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#positioningService Read more...} */ get positioningService(): PositioningService | nullish; set positioningService(value: PositioningServiceProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): IPSInfo; } interface IPSInfoProperties { /** * Defines the configuration properties for Indoor Positioning Data Service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#configuration Read more...} */ configuration?: ConfigurationProperties | nullish; /** * Defines the portal item for the positioning data service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-IPSInfo.html#positioningService Read more...} */ positioningService?: PositioningServiceProperties | nullish; } export interface TimeSlider extends Accessor, JSONSupport { } export class TimeSlider { /** * When `true`, the time slider will play its animation in a loop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#loop Read more...} */ loop: boolean; /** * The number of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#numStops Read more...} */ numStops: number | nullish; /** * The thumb count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#numThumbs Read more...} */ numThumbs: number; /** * The time rate in milliseconds between animation steps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stopDelay Read more...} */ stopDelay: number; /** * An array of dates for the time slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stops Read more...} */ stops: Date[] | nullish; /** * Time animation is controlled by a configurable {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html time slider}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html Read more...} */ constructor(properties?: TimeSliderProperties); /** * The current time extent of the time slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#currentTimeExtent Read more...} */ get currentTimeExtent(): TimeExtent | nullish; set currentTimeExtent(value: TimeExtentProperties | nullish); /** * The temporal extent for the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#fullTimeExtent Read more...} */ get fullTimeExtent(): TimeExtent | nullish; set fullTimeExtent(value: TimeExtentProperties | nullish); /** * Defines regularly spaced stops on the time slider from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stopInterval Read more...} */ get stopInterval(): TimeInterval | nullish; set stopInterval(value: TimeIntervalProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TimeSlider; } interface TimeSliderProperties { /** * The current time extent of the time slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#currentTimeExtent Read more...} */ currentTimeExtent?: TimeExtentProperties | nullish; /** * The temporal extent for the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#fullTimeExtent Read more...} */ fullTimeExtent?: TimeExtentProperties | nullish; /** * When `true`, the time slider will play its animation in a loop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#loop Read more...} */ loop?: boolean; /** * The number of stops. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#numStops Read more...} */ numStops?: number | nullish; /** * The thumb count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#numThumbs Read more...} */ numThumbs?: number; /** * The time rate in milliseconds between animation steps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stopDelay Read more...} */ stopDelay?: number; /** * Defines regularly spaced stops on the time slider from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval} object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stopInterval Read more...} */ stopInterval?: TimeIntervalProperties | nullish; /** * An array of dates for the time slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-widgets-TimeSlider.html#stops Read more...} */ stops?: Date[] | nullish; } export interface WebDocument2D extends Map, corePromise { } export class WebDocument2D { /** * The name of the application that authored the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#authoringApp Read more...} */ authoringApp: string | nullish; /** * The version of the application that authored the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#authoringAppVersion Read more...} */ authoringAppVersion: string | nullish; /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#loadError Read more...} */ readonly loadError: Error | nullish; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#loadStatus Read more...} */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The URL to the thumbnail used for the webmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#thumbnailUrl Read more...} */ thumbnailUrl: string | nullish; /** * WebDocument2D is the base class for all 2D web documents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html Read more...} */ constructor(properties?: WebDocument2DProperties); /** * The applicationProperties contains the viewing properties of the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#applicationProperties Read more...} */ get applicationProperties(): ApplicationProperties | nullish; set applicationProperties(value: ApplicationPropertiesProperties | nullish); /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#bookmarks Read more...} */ get bookmarks(): Collection; set bookmarks(value: CollectionProperties); /** * When a web map is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#floorInfo Read more...} */ get floorInfo(): MapFloorInfo | nullish; set floorInfo(value: MapFloorInfoProperties | nullish); /** * The initial view of the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#initialViewProperties Read more...} */ get initialViewProperties(): InitialViewProperties; set initialViewProperties(value: InitialViewPropertiesProperties); /** * The portal item from which the WebMap is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#widgets Read more...} */ get widgets(): Widgets | nullish; set widgets(value: WidgetsProperties | nullish); /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#isResolved Read more...} */ isResolved(): boolean; /** * Triggers the loading of the WebMap instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#load Read more...} */ load(): Promise; /** * Loads all the externally loadable resources associated with the webmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#loadAll Read more...} */ loadAll(): Promise; /** * Saves the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html WebLinkChart} to its associated portal item. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#save Read more...} */ save(options?: WebDocument2DSaveOptions): Promise; /** * Saves the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html WebLinkChart} to a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * @param portalItem The new portal item to which the `WebMap` / `WebLinkChart` will be saved. Portal item properties such as the title or description need to be explicitly set on the item and will not be automatically copied from the current associated `WebMap` / `WebLinkChart` portal item (if any). * @param options Additional save options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: WebDocument2DSaveAsOptions): Promise; /** * Update properties of the WebMap related to the view. * * @param view The view to update from. * @param options Update options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#updateFrom Read more...} */ updateFrom(view: MapView, options?: WebDocument2DUpdateFromOptions): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface WebDocument2DProperties extends MapProperties { /** * The applicationProperties contains the viewing properties of the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#applicationProperties Read more...} */ applicationProperties?: ApplicationPropertiesProperties | nullish; /** * The name of the application that authored the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#authoringApp Read more...} */ authoringApp?: string | nullish; /** * The version of the application that authored the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#authoringAppVersion Read more...} */ authoringAppVersion?: string | nullish; /** * An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#bookmarks Read more...} */ bookmarks?: CollectionProperties; /** * When a web map is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#floorInfo Read more...} */ floorInfo?: MapFloorInfoProperties | nullish; /** * The initial view of the WebMap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#initialViewProperties Read more...} */ initialViewProperties?: InitialViewPropertiesProperties; /** * The portal item from which the WebMap is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * The URL to the thumbnail used for the webmap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#thumbnailUrl Read more...} */ thumbnailUrl?: string | nullish; /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebDocument2D.html#widgets Read more...} */ widgets?: WidgetsProperties | nullish; } export interface WebDocument2DSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface WebDocument2DSaveOptions { ignoreUnsupported?: boolean; } export interface WebDocument2DUpdateFromOptions { backgroundExcluded?: boolean; viewpointExcluded?: boolean; scalePreserved?: boolean; thumbnailExcluded?: boolean; thumbnailSize?: WebDocument2DUpdateFromOptionsThumbnailSize; widgetsExcluded?: boolean; } export interface WebDocument2DUpdateFromOptionsThumbnailSize { width: number; height: number; } export class WebLinkChart extends WebDocument2D { /** * The active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html link chart layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#activeLinkChartLayer Read more...} */ readonly activeLinkChartLayer: LinkChartLayer | nullish; /** * The extent of the current layout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#diagramNodesExtent Read more...} */ readonly diagramNodesExtent: Extent | nullish; /** * The number of entities in the link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#entityCount Read more...} */ readonly entityCount: number; /** * The knowledge graph service containing the data displayed in the link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#knowledgeGraph Read more...} */ readonly knowledgeGraph: KnowledgeGraph; /** * The map type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#mapType Read more...} */ mapType: "webLinkChart"; /** * The number of relationship in the link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#relationshipCount Read more...} */ readonly relationshipCount: number; /** * The WebLinkChart class contains properties and methods for storing, managing, and overlaying layers in a link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html Read more...} */ constructor(properties?: WebLinkChartProperties); /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html Properties} specific to the link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#linkChartProperties Read more...} */ get linkChartProperties(): LinkChartProperties; set linkChartProperties(value: LinkChartPropertiesProperties); /** * Adds records to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html link chart layer}, given an array of paired ids and named types for each record to add. * * @param records An array of objects with an id and named type to be added to the link chart. * @param options Additional options that can be set when adding records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#addRecords Read more...} */ addRecords(records: IdTypePair[], options?: WebLinkChartAddRecordsOptions): Promise; /** * Change the layout applied to the link chart. * * @param layoutMode The layout applied to the link chart. * @param options * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#applyLayout Read more...} */ applyLayout(layoutMode: | "organic-standard" | "organic-community" | "basic-grid" | "hierarchical-bottom-to-top" | "radial-root-centric" | "tree-left-to-right" | "geographic-organic-standard" | "chronological-mono-timeline" | "chronological-multi-timeline", options?: WebLinkChartApplyLayoutOptions): Promise; /** * Indicates whether the nonspatial data on the link chart is visible. * * @param mode A map with a key of the named Type and the list of Identifiers to be added * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#changeNonspatialDataDisplay Read more...} */ changeNonspatialDataDisplay(mode: "hidden" | "visible"): void; /** * Connect between entities adds any existing direct relationships between the selected entities. * * @param entityIds List of entity ids on the link chart to find direct relationships between. * @param options Additional options for the connect request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#connectBetweenEntities Read more...} */ connectBetweenEntities(entityIds: string[], options?: GeneralOptions): Promise; /** * Connect from entities adds any existing direct relationships between the specified entities and any other entities in the link chart. * * @param entityIds List of entity ids on the link chart to find direct relationships to any other entities on the link chart. * @param options Additional options for the connect request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#connectFromEntities Read more...} */ connectFromEntities(entityIds: string[], options?: GeneralOptions): Promise; createSublayerForNamedType(typeName: string): Promise; /** * Given a list of entity IDs to expand from, will attempt to retrieve all one-hop connected entities and the connecting relationships. * * @param nodeIds Array of entity IDs to expand from. * @param options Additional options for the expand request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#expand Read more...} */ expand(nodeIds: string[], options?: WebLinkChartExpandOptions): Promise; /** * Retrieve the record IDs for all instances of a specified named type in the link chart. * * @param typeName The named type to get the member ids for * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#getMemberIdsByType Read more...} */ getMemberIdsByType(typeName: string): string[]; /** * Refreshes the data in the link chart. * * @param ids List of specific entities and relationships to update. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#refreshLinkChartData Read more...} */ refreshLinkChartData(ids?: string[]): Promise; /** * Removes records from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-LinkChartLayer.html link chart layer}. * * @param records An array of objects with an id and named type to be removed from the link chart. * @param options Additional options that can be set when removing records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#removeRecords Read more...} */ removeRecords(records: IdTypePair[], options?: WebLinkChartRemoveRecordsOptions): Promise; } interface WebLinkChartProperties extends WebDocument2DProperties { /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-linkChart-LinkChartProperties.html Properties} specific to the link chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#linkChartProperties Read more...} */ linkChartProperties?: LinkChartPropertiesProperties; /** * The map type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#mapType Read more...} */ mapType?: "webLinkChart"; } /** * General options for web link chart methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebLinkChart.html#GeneralOptions Read more...} */ export interface GeneralOptions { signal?: AbortSignal | nullish; } export interface WebLinkChartAddRecordsOptions { cascadeAddRelationshipEndNodes?: boolean; signal?: AbortSignal | nullish; } export interface WebLinkChartApplyLayoutOptions { layoutSettings?: LayoutSettings; lockedNodeLocations?: globalThis.Map; } export interface WebLinkChartExpandOptions { relationshipTypeNames?: string[]; signal?: AbortSignal | nullish; } export interface WebLinkChartRemoveRecordsOptions { signal?: AbortSignal | nullish; } export class WebMap extends WebDocument2D { /** * Provides multiple slides. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#presentation Read more...} */ presentation: any; /** * The version of the source document from which the WebMap was read. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#sourceVersion Read more...} */ readonly sourceVersion: WebMapSourceVersion | nullish; /** * Loads a [WebMap](https://doc.geoscene.cn/geoscene-online/create-maps/make-your-first-map.htm) * from [GeoScene Online](https://www.geosceneonline.cn/geoscene/home/) or * [GeoScene Enterprise portal](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/what-is-portal-for-geoscene-.htm) * into a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html Read more...} */ constructor(properties?: WebMapProperties); /** * Information relating to a list of Geotriggers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#geotriggersInfo Read more...} */ get geotriggersInfo(): GeotriggersInfo | nullish; set geotriggersInfo(value: GeotriggersInfoProperties | nullish); /** * Contains indoor positioning system information for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#ipsInfo Read more...} */ get ipsInfo(): IPSInfo | nullish; set ipsInfo(value: IPSInfoProperties | nullish); /** * The utilityNetworks object contains a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html UtilityNetworks} saved on the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#utilityNetworks Read more...} */ get utilityNetworks(): Collection | nullish; set utilityNetworks(value: CollectionProperties | nullish); /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [web map specification](https://doc.geoscene.cn/web-map-specification/) for more detailed information on serializing web map to JSON. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#fromJSON Read more...} */ static fromJSON(json: any): any; } interface WebMapProperties extends WebDocument2DProperties { /** * Information relating to a list of Geotriggers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#geotriggersInfo Read more...} */ geotriggersInfo?: GeotriggersInfoProperties | nullish; /** * Contains indoor positioning system information for the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#ipsInfo Read more...} */ ipsInfo?: IPSInfoProperties | nullish; /** * Provides multiple slides. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#presentation Read more...} */ presentation?: any; /** * The utilityNetworks object contains a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html UtilityNetworks} saved on the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#utilityNetworks Read more...} */ utilityNetworks?: CollectionProperties | nullish; } export class ApplicationProperties extends Accessor { /** * Represents configuration of application and UI elements of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-ApplicationProperties.html Read more...} */ constructor(properties?: ApplicationPropertiesProperties); /** * View-specific properties of application and UI elements for the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-ApplicationProperties.html#viewing Read more...} */ get viewing(): Viewing | nullish; set viewing(value: ViewingProperties | nullish); } interface ApplicationPropertiesProperties { /** * View-specific properties of application and UI elements for the web map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-ApplicationProperties.html#viewing Read more...} */ viewing?: ViewingProperties | nullish; } export interface ColorBackground extends Accessor, JSONSupport { } export class ColorBackground { /** * Represents the background color of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} * when displayed in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html Read more...} */ constructor(properties?: ColorBackgroundProperties); /** * The color of the background. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Creates a deep clone of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html#clone Read more...} */ clone(): ColorBackground; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColorBackground; } interface ColorBackgroundProperties { /** * The color of the background. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-background-ColorBackground.html#color Read more...} */ color?: ColorProperties; } export interface Bookmark extends Accessor, JSONSupport, Identifiable { } export class Bookmark { /** * The name of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#name Read more...} */ name: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * A bookmark is a saved map extent that allows end users to quickly navigate to a particular area of interest * using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html Bookmarks} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Read more...} */ constructor(properties?: BookmarkProperties); /** * The URL for a thumbnail image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#thumbnail Read more...} */ get thumbnail(): BookmarkThumbnail | nullish; set thumbnail(value: BookmarkThumbnailProperties | nullish); /** * The time extent of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The viewpoint of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#viewpoint Read more...} */ get viewpoint(): Viewpoint; set viewpoint(value: ViewpointProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Bookmark; } interface BookmarkProperties extends IdentifiableProperties { /** * The name of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#name Read more...} */ name?: string; /** * The URL for a thumbnail image. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#thumbnail Read more...} */ thumbnail?: BookmarkThumbnailProperties | nullish; /** * The time extent of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The viewpoint of the bookmark item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties; } export interface BookmarkThumbnailProperties { url?: string; } export interface BookmarkThumbnail extends AnonymousAccessor { url: string; } export interface InitialViewProperties extends Accessor, Clonable { } export class InitialViewProperties { /** * The initial time zone of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#timeZone Read more...} */ timeZone: string; /** * Represents the initial viewing state of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} * when displayed in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html Read more...} */ constructor(properties?: InitialViewPropertiesProperties); /** * The background color of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#background Read more...} */ get background(): ColorBackground | nullish; set background(value: ColorBackgroundProperties | nullish); /** * The spatial reference of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * The initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The initial viewpoint of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#viewpoint Read more...} */ get viewpoint(): Viewpoint | nullish; set viewpoint(value: ViewpointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#clone Read more...} */ clone(): this; } interface InitialViewPropertiesProperties { /** * The background color of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#background Read more...} */ background?: ColorBackgroundProperties | nullish; /** * The spatial reference of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * The initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html time extent} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The initial time zone of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#timeZone Read more...} */ timeZone?: string; /** * The initial viewpoint of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-InitialViewProperties.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties | nullish; } /** * Floor filtering is controlled by a configurable {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html floor filter}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#FloorFilter Read more...} */ export interface WebMapFloorFilterProperties { enabled?: boolean; longNames?: boolean; minimized?: boolean; pinnedLevels?: boolean; site?: string | nullish; facility?: string | nullish; level?: string | nullish; } /** * Floor filtering is controlled by a configurable {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html floor filter}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#FloorFilter Read more...} */ export interface WebMapFloorFilter extends AnonymousAccessor { enabled: boolean; longNames: boolean; minimized: boolean; pinnedLevels: boolean; site: string | nullish; facility: string | nullish; level: string | nullish; } export interface WebMapSourceVersion { major: number; minor: number; } /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#Widgets Read more...} */ export interface WidgetsProperties { timeSlider?: TimeSliderProperties | nullish; floorFilter?: WebMapFloorFilterProperties | nullish; } /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#Widgets Read more...} */ export interface Widgets extends AnonymousAccessor { get timeSlider(): TimeSlider | nullish; set timeSlider(value: TimeSliderProperties | nullish); get floorFilter(): WebMapFloorFilter | nullish; set floorFilter(value: WebMapFloorFilterProperties | nullish); } export interface WebScene extends Map, corePromise { } export class WebScene { /** * The name of the application that authored the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#authoringApp Read more...} */ authoringApp: string; /** * The version of the application that authored the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#authoringAppVersion Read more...} */ authoringAppVersion: string; /** * *This property only applies to local scenes.* * Determines whether clipping using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingArea clippingArea} is * enabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingEnabled Read more...} */ clippingEnabled: boolean; /** * Indicates whether the instance has loaded. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#loaded Read more...} */ readonly loaded: boolean; /** * The Error object returned if an error occurred while loading. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#loadError Read more...} */ readonly loadError: Error | nullish; /** * Represents the status of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#load load} operation. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#loadStatus Read more...} */ readonly loadStatus: "not-loaded" | "loading" | "failed" | "loaded"; /** * The version of the source document from which the WebScene was read. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#sourceVersion Read more...} */ readonly sourceVersion: WebSceneSourceVersion | nullish; /** * The URL to the thumbnail used for the web scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#thumbnailUrl Read more...} */ thumbnailUrl: string | nullish; /** * The latest supported webscene spec version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#version Read more...} */ static readonly version: string; /** * The web scene is the core element of 3D mapping across GeoScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html Read more...} */ constructor(properties?: WebSceneProperties); /** * Configuration of application and UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#applicationProperties Read more...} */ get applicationProperties(): websceneApplicationProperties | nullish; set applicationProperties(value: websceneApplicationPropertiesProperties | nullish); /** * *This property only applies to local scenes.* * Represents an optional clipping area used to define the * bounds or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of a local scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingArea Read more...} */ get clippingArea(): Extent | nullish; set clippingArea(value: ExtentProperties | nullish); /** * When a web scene is configured as floor-aware, it has a floorInfo property defined. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#floorInfo Read more...} */ get floorInfo(): MapFloorInfo | nullish; set floorInfo(value: MapFloorInfoProperties | nullish); /** * The height model info of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#heightModelInfo Read more...} */ get heightModelInfo(): HeightModelInfo | nullish; set heightModelInfo(value: HeightModelInfoProperties | nullish); /** * The initial view of the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#initialViewProperties Read more...} */ get initialViewProperties(): websceneInitialViewProperties; set initialViewProperties(value: websceneInitialViewPropertiesProperties); /** * The portal item from which the WebScene is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#portalItem Read more...} */ get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); /** * Provides a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of slides * that act as bookmarks for saving predefined {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html viewpoints} * and visible layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#presentation Read more...} */ get presentation(): Presentation; set presentation(value: PresentationProperties); /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#widgets Read more...} */ get widgets(): WebSceneWidgets | nullish; set widgets(value: WebSceneWidgetsProperties | nullish); /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#isResolved Read more...} */ isResolved(): boolean; /** * Triggers the loading of the WebScene instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#load Read more...} */ load(): Promise; /** * Loads all the externally loadable resources associated with the webscene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#loadAll Read more...} */ loadAll(): Promise; /** * Saves the webscene to its associated portal item. * * @param options Additional options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#save Read more...} */ save(options?: WebSceneSaveOptions): Promise; /** * Saves the webscene to a new portal item. * * @param portalItem The new portal item to which the scene will be saved. Portal item properties such as the title or description need to be explicitly set on the item and will not be automatically copied from the current associated scene portal item (if any). * @param options additional save options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#saveAs Read more...} */ saveAs(portalItem: PortalItemProperties, options?: WebSceneSaveAsOptions): Promise; /** * Converts an instance of this class to its GeoScene portal JSON representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#toJSON Read more...} */ toJSON(): any; /** * Update properties of the WebScene related to the view. * * @param view The view to update from. * @param options Update options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#updateFrom Read more...} */ updateFrom(view: SceneView, options?: WebSceneUpdateFromOptions): Promise; /** * Update the thumbnail of the WebScene by taking a screenshot of the view. * * @param view The view to update from. * @param options Update options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#updateThumbnail Read more...} */ updateThumbnail(view: SceneView, options?: WebSceneUpdateThumbnailOptions): Promise; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [web scene specification](https://doc.geoscene.cn/web-scene-specification/) for more detailed information on serializing web scenes to JSON. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#fromJSON Read more...} */ static fromJSON(json: any): WebScene; } interface WebSceneProperties extends MapProperties { /** * Configuration of application and UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#applicationProperties Read more...} */ applicationProperties?: websceneApplicationPropertiesProperties | nullish; /** * The name of the application that authored the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#authoringApp Read more...} */ authoringApp?: string; /** * The version of the application that authored the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#authoringAppVersion Read more...} */ authoringAppVersion?: string; /** * *This property only applies to local scenes.* * Represents an optional clipping area used to define the * bounds or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Extent.html Extent} of a local scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingArea Read more...} */ clippingArea?: ExtentProperties | nullish; /** * *This property only applies to local scenes.* * Determines whether clipping using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingArea clippingArea} is * enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#clippingEnabled Read more...} */ clippingEnabled?: boolean; /** * When a web scene is configured as floor-aware, it has a floorInfo property defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#floorInfo Read more...} */ floorInfo?: MapFloorInfoProperties | nullish; /** * The height model info of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#heightModelInfo Read more...} */ heightModelInfo?: HeightModelInfoProperties | nullish; /** * The initial view of the WebScene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#initialViewProperties Read more...} */ initialViewProperties?: websceneInitialViewPropertiesProperties; /** * The portal item from which the WebScene is loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#portalItem Read more...} */ portalItem?: PortalItemProperties | nullish; /** * Provides a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of slides * that act as bookmarks for saving predefined {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html viewpoints} * and visible layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#presentation Read more...} */ presentation?: PresentationProperties; /** * The URL to the thumbnail used for the web scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#thumbnailUrl Read more...} */ thumbnailUrl?: string | nullish; /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#widgets Read more...} */ widgets?: WebSceneWidgetsProperties | nullish; } export class websceneApplicationProperties extends Accessor { /** * Represents configuration of application and UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-ApplicationProperties.html Read more...} */ constructor(properties?: websceneApplicationPropertiesProperties); /** * View-specific properties of application and UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-ApplicationProperties.html#viewing Read more...} */ get viewing(): Viewing | nullish; set viewing(value: ViewingProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-ApplicationProperties.html#clone Read more...} */ clone(): websceneApplicationProperties; } interface websceneApplicationPropertiesProperties { /** * View-specific properties of application and UI elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-ApplicationProperties.html#viewing Read more...} */ viewing?: ViewingProperties | nullish; } export interface Background extends Accessor, JSONSupport { } export class Background { /** * The background of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} that lies behind the sky, atmosphere and stars. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-Background.html Read more...} */ constructor(properties?: BackgroundProperties); /** * Creates a deep clone of the Background. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-Background.html#clone Read more...} */ clone(): Background; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-Background.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-Background.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Background; } interface BackgroundProperties { } export interface backgroundColorBackground extends Background, JSONSupport { } export class backgroundColorBackground { /** * This type of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-Background.html Background} allows to set a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Color.html Color} * as the background of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html Read more...} */ constructor(properties?: backgroundColorBackgroundProperties); /** * The color of the background. * * @default "black" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Creates a deep clone of the object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html#clone Read more...} */ clone(): backgroundColorBackground; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): backgroundColorBackground; } interface backgroundColorBackgroundProperties extends BackgroundProperties { /** * The color of the background. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-background-ColorBackground.html#color Read more...} */ color?: ColorProperties; } export class Environment extends Accessor { /** * Specifies whether the atmosphere should be displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#atmosphereEnabled Read more...} */ atmosphereEnabled: boolean; /** * Specifies whether stars should be displayed in the sky. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#starsEnabled Read more...} */ starsEnabled: boolean; /** * Represents settings that affect the environment in * which the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene} is displayed (such as lighting). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html Read more...} */ constructor(properties?: EnvironmentProperties); /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#background Read more...} */ get background(): Background | nullish; set background(value: BackgroundProperties | nullish); /** * Settings for defining the lighting of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#lighting Read more...} */ get lighting(): websceneSunLighting | websceneVirtualLighting; set lighting(value: | (websceneSunLightingProperties & { type?: "sun" }) | (websceneVirtualLightingProperties & { type: "virtual" })); /** * Indicates the type of weather visualization in the scene. * * @default SunnyWeather * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#weather Read more...} */ get weather(): SunnyWeather | CloudyWeather | RainyWeather | SnowyWeather | FoggyWeather; set weather(value: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" })); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#clone Read more...} */ clone(): Environment; } interface EnvironmentProperties { /** * Specifies whether the atmosphere should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#atmosphereEnabled Read more...} */ atmosphereEnabled?: boolean; /** * Specifies how the background of the scene (which lies behind sky, stars and atmosphere) should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#background Read more...} */ background?: BackgroundProperties | nullish; /** * Settings for defining the lighting of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#lighting Read more...} */ lighting?: | (websceneSunLightingProperties & { type?: "sun" }) | (websceneVirtualLightingProperties & { type: "virtual" }); /** * Specifies whether stars should be displayed in the sky. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#starsEnabled Read more...} */ starsEnabled?: boolean; /** * Indicates the type of weather visualization in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html#weather Read more...} */ weather?: | (SunnyWeatherProperties & { type: "sunny" }) | (CloudyWeatherProperties & { type: "cloudy" }) | (RainyWeatherProperties & { type: "rainy" }) | (SnowyWeatherProperties & { type: "snowy" }) | (FoggyWeatherProperties & { type: "foggy" }); } export interface websceneInitialViewProperties extends Accessor, Clonable { } export class websceneInitialViewProperties { /** * The viewing mode of the scene. * * @default "global" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#viewingMode Read more...} */ viewingMode: "global" | "local"; /** * Represents the initial viewing state of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene} * when displayed in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html Read more...} */ constructor(properties?: websceneInitialViewPropertiesProperties); /** * List of initial analyses. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#analyses Read more...} */ get analyses(): Collection; set analyses(value: CollectionProperties); /** * The initial environment settings of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#environment Read more...} */ get environment(): Environment; set environment(value: EnvironmentProperties); /** * The spatial reference of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * The initial time extent of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The initial viewpoint of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#viewpoint Read more...} */ get viewpoint(): Viewpoint | nullish; set viewpoint(value: ViewpointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#clone Read more...} */ clone(): this; } interface websceneInitialViewPropertiesProperties { /** * List of initial analyses. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#analyses Read more...} */ analyses?: CollectionProperties; /** * The initial environment settings of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#environment Read more...} */ environment?: EnvironmentProperties; /** * The spatial reference of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * The initial time extent of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The viewing mode of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#viewingMode Read more...} */ viewingMode?: "global" | "local"; /** * The initial viewpoint of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-InitialViewProperties.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties | nullish; } export interface Presentation extends Accessor, Clonable, JSONSupport { } export class Presentation { /** * A presentation contains a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html slides} that allows users to quickly * navigate to predefined settings of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html Read more...} */ constructor(properties?: PresentationProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html slides} that bookmark * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html viewpoints}, visible layers, and other settings * previously defined in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides Read more...} */ get slides(): Collection; set slides(value: CollectionProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): Presentation; } interface PresentationProperties { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html slides} that bookmark * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html viewpoints}, visible layers, and other settings * previously defined in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides Read more...} */ slides?: CollectionProperties; } export class Slide extends Accessor { /** * The visibility of a slide in a presentation. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#hidden Read more...} */ hidden: boolean; /** * The unique id of a slide within the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides slides property} of a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html Presentation}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#id Read more...} */ id: string; /** * Layout of the slide. * * @default "caption" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#layout Read more...} */ layout: "caption" | "cover" | "none"; /** * A slide stores a snapshot of several pre-set properties of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}, such as * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#basemap basemap}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#viewpoint viewpoint} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#visibleLayers visible layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html Read more...} */ constructor(properties?: SlideProperties); /** * The basemap of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#basemap Read more...} */ get basemap(): Basemap | nullish; set basemap(value: BasemapProperties | nullish | string); /** * The description of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#description Read more...} */ get description(): SlideDescription; set description(value: SlideDescriptionProperties | string); /** * The elements object contains configurations for components set in a slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#elements Read more...} */ get elements(): SlideElements | nullish; set elements(value: SlideElementsProperties | nullish); /** * The enabled focus areas of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#enabledFocusAreas Read more...} */ get enabledFocusAreas(): Collection | nullish; set enabledFocusAreas(value: CollectionProperties | nullish); /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#environment Read more...} */ get environment(): SlideEnvironment; set environment(value: SlideEnvironmentProperties); /** * Ground properties for this slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#ground Read more...} */ get ground(): SlideGround | nullish; set ground(value: SlideGroundProperties | nullish); /** * A data URI encoded thumbnail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#thumbnail Read more...} */ get thumbnail(): SlideThumbnail; set thumbnail(value: SlideThumbnailProperties | string); /** * The time extent of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The title of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#title Read more...} */ get title(): SlideTitle; set title(value: SlideTitleProperties | string); /** * The viewpoint of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#viewpoint Read more...} */ get viewpoint(): Viewpoint; set viewpoint(value: ViewpointProperties); /** * The visible layers of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#visibleLayers Read more...} */ get visibleLayers(): Collection; set visibleLayers(value: CollectionProperties); /** * Applies a slide's settings to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @param view The SceneView the slide should be applied to. * @param options Animation options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#applyTo Read more...} */ applyTo(view: SceneView, options?: SlideApplyToOptions): Promise; /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#clone Read more...} */ clone(): Slide; /** * Updates a slide from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides WebScene's slides}. * * @param view The SceneView from which the slide should update. * @param options Update options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#updateFrom Read more...} */ updateFrom(view: SceneView, options?: SlideUpdateFromOptions): Promise; /** * Creates a slide from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}, which may be added to the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides slides} in the WebScene's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#presentation presentation}. * * @param view The SceneView from which the slide should be created. * @param options Creation options. See properties below for object specifications. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#createFrom Read more...} */ static createFrom(view: SceneView, options?: SlideCreateFromOptions): Promise; } interface SlideProperties { /** * The basemap of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#basemap Read more...} */ basemap?: BasemapProperties | nullish | string; /** * The description of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#description Read more...} */ description?: SlideDescriptionProperties | string; /** * The elements object contains configurations for components set in a slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#elements Read more...} */ elements?: SlideElementsProperties | nullish; /** * The enabled focus areas of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#enabledFocusAreas Read more...} */ enabledFocusAreas?: CollectionProperties | nullish; /** * Represents settings that affect the environment in which the WebScene is displayed (such as lighting). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#environment Read more...} */ environment?: SlideEnvironmentProperties; /** * Ground properties for this slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#ground Read more...} */ ground?: SlideGroundProperties | nullish; /** * The visibility of a slide in a presentation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#hidden Read more...} */ hidden?: boolean; /** * The unique id of a slide within the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html#slides slides property} of a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Presentation.html Presentation}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#id Read more...} */ id?: string; /** * Layout of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#layout Read more...} */ layout?: "caption" | "cover" | "none"; /** * A data URI encoded thumbnail. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#thumbnail Read more...} */ thumbnail?: SlideThumbnailProperties | string; /** * The time extent of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * The title of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#title Read more...} */ title?: SlideTitleProperties | string; /** * The viewpoint of the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties; /** * The visible layers of the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html#visibleLayers Read more...} */ visibleLayers?: CollectionProperties; } export interface SlideApplyToOptions { animate?: boolean; speedFactor?: number; duration?: number; maxDuration?: number; easing?: | "linear" | "cubic-in" | "cubic-out" | "cubic-in-out" | "expo-in" | "expo-out" | "expo-in-out" | "quad-in-out-coast" | "in-cubic" | "out-cubic" | "in-out-cubic" | "in-expo" | "out-expo" | "in-out-expo" | "in-out-coast-quad" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | EasingFunction; signal?: AbortSignal | nullish; } export interface SlideCreateFromOptions { screenshot?: SlideCreateFromOptionsScreenshot; } export interface SlideCreateFromOptionsScreenshot { format?: string; quality?: number; width?: number; height?: number; } export interface SlideDescriptionProperties { text?: string; } export interface SlideDescription extends AnonymousAccessor { text: string; } export interface SlideEnvironmentProperties { lighting?: | (websceneSunLightingProperties & { type?: "sun" }) | (websceneVirtualLightingProperties & { type: "virtual" }); } export interface SlideEnvironment extends AnonymousAccessor { get lighting(): websceneSunLighting | websceneVirtualLighting; set lighting(value: | (websceneSunLightingProperties & { type?: "sun" }) | (websceneVirtualLightingProperties & { type: "virtual" })); } export interface SlideGroundProperties { opacity?: number | nullish; } export interface SlideGround extends AnonymousAccessor { opacity: number | nullish; } export interface SlideThumbnailProperties { url?: string; } export interface SlideThumbnail extends AnonymousAccessor { url: string; } export interface SlideTitleProperties { text?: string; } export interface SlideTitle extends AnonymousAccessor { text: string; } export interface SlideUpdateFromOptions { screenshot: SlideUpdateFromOptionsScreenshot; } export interface SlideUpdateFromOptionsScreenshot { format?: string; quality?: number; width?: number; height?: number; } export interface SlideVisibleLayersProperties { id?: string; sublayerIds?: number[] | nullish; } export interface SlideVisibleLayers extends AnonymousAccessor { id: string; sublayerIds: number[] | nullish; } export interface SlideLegendInfo extends Accessor, JSONSupport, Clonable { } export class SlideLegendInfo { /** * Legend component visibility in slide. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html#visible Read more...} */ visible: boolean; /** * The slide legend info object is part of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html webscene/support/SlideElements} and contains information relating to * how the legend component is shown in the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html Read more...} */ constructor(properties?: SlideLegendInfoProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SlideLegendInfo; } interface SlideLegendInfoProperties { /** * Legend component visibility in slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SlideLegendInfo.html#visible Read more...} */ visible?: boolean; } export class websceneSunLighting extends Accessor { /** * Indicates whether to show shadows cast by the sun. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#directShadowsEnabled Read more...} */ directShadowsEnabled: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#displayUTCOffset Read more...} */ displayUTCOffset: number | nullish; /** * Indicates that the light source is simulated position of the sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#type Read more...} */ readonly type: "sun"; /** * The sun lighting object is part of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html webscene/Environment} and contains information relating to * how a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} is lit by the sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html Read more...} */ constructor(properties?: websceneSunLightingProperties); /** * The current date and time of the simulated sun. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#date Read more...} */ get date(): Date; set date(value: DateProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#clone Read more...} */ clone(): websceneSunLighting; } interface websceneSunLightingProperties { /** * The current date and time of the simulated sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#date Read more...} */ date?: DateProperties; /** * Indicates whether to show shadows cast by the sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#directShadowsEnabled Read more...} */ directShadowsEnabled?: boolean; /** * The UTC time zone offset in hours that should be displayed in the UI to represent the date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-SunLighting.html#displayUTCOffset Read more...} */ displayUTCOffset?: number | nullish; } export interface FeatureReference extends Accessor, Clonable, JSONSupport { } export class FeatureReference { /** * References a feature by unique id, layer id, and sublayer id, if applicable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html Read more...} */ constructor(properties?: FeatureReferenceProperties); /** * Unique identifier for the feature inside the layer or sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#id Read more...} */ get id(): FeatureReferenceObjectId | FeatureReferenceGlobalId; set id(value: | (FeatureReferenceObjectIdProperties & { type: "object-id" }) | (FeatureReferenceGlobalIdProperties & { type: "global-id" })); /** * Identifies the layer and, if applicable, the sublayer to which the feature belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#layerReference Read more...} */ get layerReference(): LayerReference; set layerReference(value: LayerReferenceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReference; } interface FeatureReferenceProperties { /** * Unique identifier for the feature inside the layer or sublayer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#id Read more...} */ id?: | (FeatureReferenceObjectIdProperties & { type: "object-id" }) | (FeatureReferenceGlobalIdProperties & { type: "global-id" }); /** * Identifies the layer and, if applicable, the sublayer to which the feature belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReference.html#layerReference Read more...} */ layerReference?: LayerReferenceProperties; } export interface FeatureReferenceGlobalId extends FeatureReferenceId, JSONSupport, Clonable { } export class FeatureReferenceGlobalId { /** * A string value representing the feature id type. * * @default "global-id" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#type Read more...} */ readonly type: "global-id"; /** * Feature global id value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#value Read more...} */ value: string | nullish; /** * A unique identifier of a feature inside a layer by globalid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html Read more...} */ constructor(properties?: FeatureReferenceGlobalIdProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReferenceGlobalId; } interface FeatureReferenceGlobalIdProperties extends FeatureReferenceIdProperties { /** * Feature global id value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceGlobalId.html#value Read more...} */ value?: string | nullish; } export interface FeatureReferenceId extends Accessor, JSONSupport, Clonable { } export class FeatureReferenceId { /** * A string value representing the feature id type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceId.html#type Read more...} */ readonly type: "global-id" | "object-id"; /** * A unique identifier of a feature inside a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceId.html Read more...} */ constructor(properties?: FeatureReferenceIdProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceId.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceId.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceId.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReferenceId; } interface FeatureReferenceIdProperties { } export interface FeatureReferenceObjectId extends FeatureReferenceId, JSONSupport, Clonable { } export class FeatureReferenceObjectId { /** * A string value representing the feature id type. * * @default "object-id" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#type Read more...} */ readonly type: "object-id"; /** * Feature object id value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#value Read more...} */ value: any | nullish; /** * A unique identifier of a feature inside a layer by objectid value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html Read more...} */ constructor(properties?: FeatureReferenceObjectIdProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): FeatureReferenceObjectId; } interface FeatureReferenceObjectIdProperties extends FeatureReferenceIdProperties { /** * Feature object id value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-FeatureReferenceObjectId.html#value Read more...} */ value?: any | nullish; } export interface LayerReference extends Accessor, Clonable, JSONSupport { } export class LayerReference { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#id Layer.id} referencing a layer by its id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#layerId Read more...} */ layerId: string | nullish; /** * References a sublayer within the layer identified by layerId. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#sublayerId Read more...} */ sublayerId: number | nullish; /** * References a layer by layer id, and sublayer id, if applicable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html Read more...} */ constructor(properties?: LayerReferenceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LayerReference; } interface LayerReferenceProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#id Layer.id} referencing a layer by its id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#layerId Read more...} */ layerId?: string | nullish; /** * References a sublayer within the layer identified by layerId. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-LayerReference.html#sublayerId Read more...} */ sublayerId?: number | nullish; } export interface SlideElements extends Accessor, JSONSupport, Clonable { } export class SlideElements { /** * The slide elements is part of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Slide.html webscene/Slide} and contains information relating to * how components are shown in a slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html Read more...} */ constructor(properties?: SlideElementsProperties); /** * List of analyses in the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#analyses Read more...} */ get analyses(): Collection; set analyses(value: CollectionProperties); /** * The component properties for the legend component defined for the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#legendInfo Read more...} */ get legendInfo(): SlideLegendInfo | nullish; set legendInfo(value: SlideLegendInfoProperties | nullish); /** * The component properties for the popup component defined for the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#popupInfo Read more...} */ get popupInfo(): SlidePopupInfo | nullish; set popupInfo(value: SlidePopupInfoProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SlideElements; } interface SlideElementsProperties { /** * List of analyses in the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#analyses Read more...} */ analyses?: CollectionProperties; /** * The component properties for the legend component defined for the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#legendInfo Read more...} */ legendInfo?: SlideLegendInfoProperties | nullish; /** * The component properties for the popup component defined for the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html#popupInfo Read more...} */ popupInfo?: SlidePopupInfoProperties | nullish; } export interface SlidePopupInfo extends Accessor, Clonable, JSONSupport { } export class SlidePopupInfo { /** * Index of the selected feature in the popup component. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex: number; /** * The slide popup info object is part of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlideElements.html webscene/support/SlideElements} and contains information relating to * how the popup component is shown in the slide. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html Read more...} */ constructor(properties?: SlidePopupInfoProperties); /** * A collection of featureReference * which are identifying features which will be displayed in the popup component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#features Read more...} */ get features(): Collection; set features(value: CollectionProperties); /** * Location of the popup component in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#clone Read more...} */ clone(): this; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SlidePopupInfo; } interface SlidePopupInfoProperties { /** * A collection of featureReference * which are identifying features which will be displayed in the popup component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#features Read more...} */ features?: CollectionProperties; /** * Location of the popup component in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#location Read more...} */ location?: PointProperties | nullish; /** * Index of the selected feature in the popup component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-support-SlidePopupInfo.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex?: number; } /** * A module for importing types used in WebScene modules. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html Read more...} */ namespace websceneTypes { /** * Options for updating a web scene from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneUpdateFromOptions Read more...} */ export interface WebSceneUpdateFromOptions { environmentExcluded?: boolean; viewpointExcluded?: boolean; thumbnailExcluded?: boolean; thumbnailSize?: WebSceneThumbnailSize; widgetsExcluded?: boolean; } /** * Options for updating a web scene thumbnail from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneUpdateThumbnailOptions Read more...} */ export interface WebSceneUpdateThumbnailOptions { size?: WebSceneThumbnailSize; } /** * Options for the thumbnail size when updating a web scene thumbnail from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneThumbnailSize Read more...} */ export interface WebSceneThumbnailSize { width: number; height: number; } } /** * Options for the thumbnail size when updating a web scene thumbnail from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneThumbnailSize Read more...} */ export interface WebSceneThumbnailSize { width: number; height: number; } /** * Options for updating a web scene from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneUpdateFromOptions Read more...} */ export interface WebSceneUpdateFromOptions { environmentExcluded?: boolean; viewpointExcluded?: boolean; thumbnailExcluded?: boolean; thumbnailSize?: WebSceneThumbnailSize; widgetsExcluded?: boolean; } /** * Options for updating a web scene thumbnail from a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-types.html#WebSceneUpdateThumbnailOptions Read more...} */ export interface WebSceneUpdateThumbnailOptions { size?: WebSceneThumbnailSize; } export class websceneVirtualLighting extends Accessor { /** * Indicates whether to show shadows cast by the light source. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-VirtualLighting.html#directShadowsEnabled Read more...} */ directShadowsEnabled: boolean; /** * Indicates that the light source is virtual light. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-VirtualLighting.html#type Read more...} */ readonly type: "virtual"; /** * The virtual lighting object is part of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-Environment.html webscene/Environment} and contains information * relating to how a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} is lit with a virtual light. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-VirtualLighting.html Read more...} */ constructor(properties?: websceneVirtualLightingProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-VirtualLighting.html#clone Read more...} */ clone(): websceneVirtualLighting; } interface websceneVirtualLightingProperties { /** * Indicates whether to show shadows cast by the light source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webscene-VirtualLighting.html#directShadowsEnabled Read more...} */ directShadowsEnabled?: boolean; } export interface WebSceneSaveAsOptions { folder?: PortalFolder; ignoreUnsupported?: boolean; } export interface WebSceneSaveOptions { ignoreUnsupported?: boolean; } export interface WebSceneSourceVersion { major: number; minor: number; } /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#Widgets Read more...} */ export interface WebSceneWidgetsProperties { timeSlider?: TimeSliderProperties | nullish; } /** * The widgets object contains widgets that are exposed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html#Widgets Read more...} */ export interface WebSceneWidgets extends AnonymousAccessor { get timeSlider(): TimeSlider | nullish; set timeSlider(value: TimeSliderProperties | nullish); } export class AreaMeasurement2D extends Widget { /** * Icon which represents the widget. * * @default "measure-area" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#unit Read more...} */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#unitOptions Read more...} */ unitOptions: SystemOrAreaUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#view Read more...} */ view: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#viewModel Read more...} */ viewModel: AreaMeasurement2DViewModel; /** * The AreaMeasurement2D widget calculates and displays the area and perimeter of a polygon in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html Read more...} */ constructor(properties?: AreaMeasurement2DProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); } interface AreaMeasurement2DProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#label Read more...} */ label?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#unit Read more...} */ unit?: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#unitOptions Read more...} */ unitOptions?: SystemOrAreaUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D.html#viewModel Read more...} */ viewModel?: AreaMeasurement2DViewModel; } export class AreaMeasurement2DViewModel { /** * The area and perimeter of the measurement polygon in square meters and meters respectively. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurement Read more...} */ readonly measurement: AreaMeasurement2DViewModelMeasurement | nullish; /** * This property returns the locale specific representation of the area and perimeter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#measurementLabel Read more...} */ readonly measurementLabel: AreaMeasurement2DViewModelMeasurementLabel | nullish; /** * The ViewModel's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#unit Read more...} */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#unitOptions Read more...} */ unitOptions: SystemOrAreaUnit[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#view Read more...} */ view: MapView | nullish; constructor(properties?: any); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Clears the current measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#clear Read more...} */ clear(): void; /** * Starts a new measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#start Read more...} */ start(): void; } export interface AreaMeasurement2DViewModelMeasurement { area: number; perimeter: number; geometry: any; } export interface AreaMeasurement2DViewModelMeasurementLabel { area: string; perimeter: string; } export class AreaMeasurement3D extends Widget { /** * Icon which represents the widget. * * @default "measure-area" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#unit Read more...} */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#unitOptions Read more...} */ unitOptions: SystemOrAreaUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#view Read more...} */ view: SceneView | nullish; /** * The AreaMeasurement3D widget calculates and displays the area and perimeter of a polygon. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html Read more...} */ constructor(properties?: AreaMeasurement3DProperties); /** * The area measurement analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#analysis Read more...} */ get analysis(): AreaMeasurementAnalysis; set analysis(value: AreaMeasurementAnalysisProperties & { type: "area-measurement" }); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#viewModel Read more...} */ get viewModel(): AreaMeasurement3DViewModel; set viewModel(value: AreaMeasurement3DViewModelProperties); } interface AreaMeasurement3DProperties extends WidgetProperties { /** * The area measurement analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#analysis Read more...} */ analysis?: AreaMeasurementAnalysisProperties & { type: "area-measurement" }; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#label Read more...} */ label?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#unit Read more...} */ unit?: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#unitOptions Read more...} */ unitOptions?: SystemOrAreaUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html#viewModel Read more...} */ viewModel?: AreaMeasurement3DViewModelProperties; } export class AreaMeasurement3DViewModel extends Accessor { /** * The current measurement of the area. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#measurement Read more...} */ readonly measurement: AreaMeasurement3DViewModelMeasurement | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit Read more...} */ unit: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions Read more...} */ unitOptions: SystemOrAreaUnit[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D.html AreaMeasurement3D} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-area-measurement-3d/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html Read more...} */ constructor(properties?: AreaMeasurement3DViewModelProperties); /** * The area measurement analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#analysis Read more...} */ get analysis(): AreaMeasurementAnalysis; set analysis(value: AreaMeasurementAnalysisProperties & { type: "area-measurement" }); /** * Clears the current measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#clear Read more...} */ clear(): void; /** * Starts a new measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#start Read more...} */ start(): void; } interface AreaMeasurement3DViewModelProperties { /** * The area measurement analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#analysis Read more...} */ analysis?: AreaMeasurementAnalysisProperties & { type: "area-measurement" }; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unit Read more...} */ unit?: SystemOrAreaUnit; /** * List of available units and unit systems (imperial, metric) for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#unitOptions Read more...} */ unitOptions?: SystemOrAreaUnit[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#view Read more...} */ view?: SceneView | nullish; } export interface AreaMeasurement3DViewModelMeasurement { mode: "euclidean" | "geodesic"; area: AreaMeasurement3DViewModelMeasurementValue; perimeterLength: AreaMeasurement3DViewModelMeasurementValue; } /** * Measurement value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#MeasurementValue Read more...} */ export interface AreaMeasurement3DViewModelMeasurementValue { text: string | nullish; state: string; } export class Attachments extends Widget { /** * Configures the attachment editing functionality that can be performed by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#capabilities Read more...} */ capabilities: AttachmentsCapabilities; /** * A string value indicating how to display an attachment. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#displayType Read more...} */ displayType: "auto" | "preview" | "list"; /** * Icon which represents the widget. * * @default "attachment" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#icon Read more...} */ icon: string; /** * Indicates whether there is currently an attachment being added, updated or deleted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#submitting Read more...} */ readonly submitting: boolean; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#visibleElements Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html Read more...} */ constructor(properties?: AttachmentsProperties); /** * The graphic for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#graphic Read more...} */ get graphic(): Graphic | nullish; set graphic(value: GraphicProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#viewModel Read more...} */ get viewModel(): AttachmentsViewModel; set viewModel(value: AttachmentsViewModelProperties); } interface AttachmentsProperties extends WidgetProperties { /** * Configures the attachment editing functionality that can be performed by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#capabilities Read more...} */ capabilities?: AttachmentsCapabilities; /** * A string value indicating how to display an attachment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#displayType Read more...} */ displayType?: "auto" | "preview" | "list"; /** * The graphic for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#graphic Read more...} */ graphic?: GraphicProperties | nullish; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#icon Read more...} */ icon?: string; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#viewModel Read more...} */ viewModel?: AttachmentsViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#visibleElements Read more...} */ visibleElements?: AttachmentsVisibleElements; } export class AttachmentsViewModel extends Accessor { /** * The current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html AttachmentInfo} being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#activeAttachmentInfo Read more...} */ activeAttachmentInfo: AttachmentInfo | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html AttachmentInfo} defined on a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#attachmentInfos Read more...} */ readonly attachmentInfos: Collection; /** * Configures the attachment editing functionality that can be performed by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#capabilities Read more...} */ capabilities: AttachmentsCapabilities; /** * The current mode performed by the user. * * @default "view" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#mode Read more...} */ mode: "view" | "add" | "edit"; /** * The current state of the widget. * * @default "ready" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "loading"; /** * Defines whether or not the feature supports resizing attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#supportsResizeAttachments Read more...} */ readonly supportsResizeAttachments: boolean; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html Attachments} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html Read more...} */ constructor(properties?: AttachmentsViewModelProperties); /** * The graphic for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#graphic Read more...} */ get graphic(): Graphic | nullish; set graphic(value: GraphicProperties | nullish); /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html AttachmentsOrderByInfo} indicating the display order for the attachments, and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#orderByFields Read more...} */ get orderByFields(): AttachmentsOrderByInfo[] | nullish; set orderByFields(value: AttachmentsOrderByInfoProperties[] | nullish); /** * Queries for the attachments on a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#getAttachments Read more...} */ getAttachments(): Promise; } interface AttachmentsViewModelProperties { /** * The current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-query-support-AttachmentInfo.html AttachmentInfo} being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#activeAttachmentInfo Read more...} */ activeAttachmentInfo?: AttachmentInfo | nullish; /** * Configures the attachment editing functionality that can be performed by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#capabilities Read more...} */ capabilities?: AttachmentsCapabilities; /** * The graphic for the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#graphic Read more...} */ graphic?: GraphicProperties | nullish; /** * The current mode performed by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#mode Read more...} */ mode?: "view" | "add" | "edit"; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-AttachmentsOrderByInfo.html AttachmentsOrderByInfo} indicating the display order for the attachments, and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#orderByFields Read more...} */ orderByFields?: AttachmentsOrderByInfoProperties[] | nullish; } /** * An object that specifies the available attachments capabilities. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities Read more...} */ export interface AttachmentsCapabilities { editing?: boolean; operations?: AttachmentsCapabilitiesOperations; } export interface AttachmentsCapabilitiesOperations { add?: boolean; update?: boolean; delete?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments.html#VisibleElements Read more...} */ export interface AttachmentsVisibleElements { addButton?: boolean; addSubmitButton?: boolean; cancelAddButton?: boolean; cancelUpdateButton?: boolean; deleteButton?: boolean; errorMessage?: boolean; progressBar?: boolean; updateButton?: boolean; } export class Attribution extends Widget { /** * Full attribution text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#attributionText Read more...} */ readonly attributionText: string; /** * Icon which represents the widget. * * @default "description" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#icon Read more...} */ icon: string; /** * Text used to split attribution by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * @default | * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#itemDelimiter Read more...} */ itemDelimiter: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Attribution widget displays attribution text for the layers in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html Read more...} */ constructor(properties?: AttributionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#viewModel Read more...} */ get viewModel(): AttributionViewModel; set viewModel(value: AttributionViewModelProperties); } interface AttributionProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#icon Read more...} */ icon?: string; /** * Text used to split attribution by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#itemDelimiter Read more...} */ itemDelimiter?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html#viewModel Read more...} */ viewModel?: AttributionViewModelProperties; } export class AttributionViewModel extends Accessor { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#AttributionItem AttributionItem}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#items Read more...} */ readonly items: Collection; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "loading"; /** * The view from which the view model will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution.html Attribution} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html Read more...} */ constructor(properties?: AttributionViewModelProperties); } interface AttributionViewModelProperties { /** * The view from which the view model will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * The following properties define an attribution item that contains the attribution text for a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attribution-AttributionViewModel.html#AttributionItem Read more...} */ export interface AttributionItem { text: string; layerView: LayerView; } export class BasemapGallery extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#disabled Read more...} */ disabled: boolean; /** * Indicates the heading level to use for the message "No basemaps available" when no basemaps * are available in the BasemapGallery. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "basemap" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#label Read more...} */ label: string; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The BasemapGallery widget displays a collection of images representing basemaps from GeoScene.cn or a user-defined set * of map or image services. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html Read more...} */ constructor(properties?: BasemapGalleryProperties); /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#activeBasemap Read more...} */ get activeBasemap(): Basemap | nullish; set activeBasemap(value: BasemapProperties | nullish | string); /** * The source for basemaps that the widget will display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#source Read more...} */ get source(): LocalBasemapsSource | PortalBasemapsSource; set source(value: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | Collection | Basemap[] | Portal); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#viewModel Read more...} */ get viewModel(): BasemapGalleryViewModel; set viewModel(value: BasemapGalleryViewModelProperties); } interface BasemapGalleryProperties extends WidgetProperties { /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#activeBasemap Read more...} */ activeBasemap?: BasemapProperties | nullish | string; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#disabled Read more...} */ disabled?: boolean; /** * Indicates the heading level to use for the message "No basemaps available" when no basemaps * are available in the BasemapGallery. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#label Read more...} */ label?: string; /** * The source for basemaps that the widget will display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#source Read more...} */ source?: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | Collection | Basemap[] | Portal; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html#viewModel Read more...} */ viewModel?: BasemapGalleryViewModelProperties; } export class BasemapGalleryViewModel extends Accessor { /** * The current index of the active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemapIndex Read more...} */ readonly activeBasemapIndex: number; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html BasemapGalleryItem}s representing basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#items Read more...} */ readonly items: Collection; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "loading" | "unsupported"; /** * The view from which the Basemap Gallery will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery widget} and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-basemap-gallery/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html Read more...} */ constructor(properties?: BasemapGalleryViewModelProperties); /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap Read more...} */ get activeBasemap(): Basemap | nullish; set activeBasemap(value: BasemapProperties | nullish | string); /** * The source for basemaps that the Basemap Gallery will display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#source Read more...} */ get source(): LocalBasemapsSource | PortalBasemapsSource; set source(value: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | Collection | Basemap[] | Portal); /** * A convenience function to check basemap equality. * * @param basemap1 The basemap to compare against `basemap2`. * @param basemap2 The basemap to compare against `basemap1`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#basemapEquals Read more...} */ basemapEquals(basemap1: Basemap | nullish, basemap2: Basemap | nullish): boolean; } interface BasemapGalleryViewModelProperties { /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#activeBasemap Read more...} */ activeBasemap?: BasemapProperties | nullish | string; /** * The source for basemaps that the Basemap Gallery will display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#source Read more...} */ source?: LocalBasemapsSourceProperties | PortalBasemapsSourceProperties | Collection | Basemap[] | Portal; /** * The view from which the Basemap Gallery will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class BasemapGalleryItem extends Accessor { /** * The item's associated basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap Read more...} */ basemap: Basemap; /** * The Error object returned if an error occurred. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#error Read more...} */ readonly error: Error | nullish; /** * The item's state. * * @default "loading" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#state Read more...} */ readonly state: "loading" | "ready" | "error"; /** * The view associated with this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The BasemapGalleryItem class represents one of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#items items} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html Read more...} */ constructor(properties?: BasemapGalleryItemProperties); } interface BasemapGalleryItemProperties { /** * The item's associated basemap. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#basemap Read more...} */ basemap?: Basemap; /** * The view associated with this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-BasemapGalleryItem.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class LocalBasemapsSource extends Accessor { /** * The source's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-LocalBasemapsSource.html#state Read more...} */ readonly state: string; /** * The LocalBasemapsSource class is a Collection-driven {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#source source} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html BasemapGalleryViewModel} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-LocalBasemapsSource.html Read more...} */ constructor(properties?: LocalBasemapsSourceProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps Read more...} */ get basemaps(): Collection; set basemaps(value: CollectionProperties); } interface LocalBasemapsSourceProperties { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-LocalBasemapsSource.html#basemaps Read more...} */ basemaps?: CollectionProperties; } export class PortalBasemapsSource extends LocalBasemapsSource { /** * Function used to filter basemaps after being fetched from the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction Read more...} */ filterFunction: BasemapFilter | nullish; /** * An object with key-value pairs used to create a custom basemap gallery group query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#query Read more...} */ query: any | string | nullish; /** * The source's state. * * @default "not-loaded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#state Read more...} */ readonly state: "not-loaded" | "loading" | "ready"; /** * Callback for updating basemaps after being fetched and filtered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback Read more...} */ updateBasemapsCallback: UpdateBasemapsCallback | nullish; /** * The PortalBasemapsSource class is a Portal-driven {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html#source source} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-BasemapGalleryViewModel.html BasemapGalleryViewModel} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery.html BasemapGallery} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html Read more...} */ constructor(properties?: PortalBasemapsSourceProperties); /** * The Portal from which to fetch basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal Read more...} */ get portal(): Portal; set portal(value: PortalProperties); /** * Refreshes basemaps by fetching them from the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#refresh Read more...} */ refresh(): Promise; } interface PortalBasemapsSourceProperties extends LocalBasemapsSourceProperties { /** * Function used to filter basemaps after being fetched from the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#filterFunction Read more...} */ filterFunction?: BasemapFilter | nullish; /** * The Portal from which to fetch basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#portal Read more...} */ portal?: PortalProperties; /** * An object with key-value pairs used to create a custom basemap gallery group query. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#query Read more...} */ query?: any | string | nullish; /** * Callback for updating basemaps after being fetched and filtered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapGallery-support-PortalBasemapsSource.html#updateBasemapsCallback Read more...} */ updateBasemapsCallback?: UpdateBasemapsCallback | nullish; } export type BasemapFilter = (item: Basemap, index: number, array: Basemap[]) => boolean | Promise; export type UpdateBasemapsCallback = (items: Basemap[]) => Basemap[] | Promise; export class BasemapLayerList extends Widget { /** * Specifies a function to handle filtering base layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseFilterPredicate Read more...} */ baseFilterPredicate: BaseFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseFilterText Read more...} */ baseFilterText: string; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers baseLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseItems Read more...} */ readonly baseItems: Collection; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing a base layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseListItemCreatedFunction Read more...} */ baseListItemCreatedFunction: ListItemCreatedHandler | nullish; /** * The current basemap's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#basemapTitle Read more...} */ basemapTitle: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html CatalogLayerList} widget instance that displays a catalog layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamic group layer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#catalogLayerList Read more...} */ readonly catalogLayerList: CatalogLayerList | nullish; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} specific properties. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#catalogOptions Read more...} */ catalogOptions: BasemapLayerListCatalogOptions | nullish; /** * Indicates whether the widget is collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#collapsed Read more...} */ collapsed: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#dragEnabled Read more...} */ dragEnabled: boolean; /** * Indicates whether the form to edit the basemap's title is currently visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#editingTitle Read more...} */ editingTitle: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#filterPlaceholder Read more...} */ filterPlaceholder: string; /** * Indicates the heading level to use for the widget title (i.e. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "layers" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#label Read more...} */ label: string; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#minFilterItems Read more...} */ minFilterItems: number; /** * Specifies a function to handle filtering reference layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceFilterPredicate Read more...} */ referenceFilterPredicate: ReferenceFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceFilterText Read more...} */ referenceFilterText: string; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#referenceLayers referenceLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceItems Read more...} */ readonly referenceItems: Collection; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing a reference layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceListItemCreatedFunction Read more...} */ referenceListItemCreatedFunction: ListItemCreatedHandler | nullish; /** * Specifies the selection mode. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#selectionMode Read more...} */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Determines the icons used to indicate visibility. * * @default "default" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibilityAppearance Read more...} */ visibilityAppearance: "default" | "checkbox"; /** * The BasemapLayerList widget provides a way to display a list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} layers and switch on/off their visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html Read more...} */ constructor(properties?: BasemapLayerListProperties); /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing basemap layers * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#selectedItems Read more...} */ get selectedItems(): Collection; set selectedItems(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#viewModel Read more...} */ get viewModel(): BasemapLayerListViewModel; set viewModel(value: BasemapLayerListViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements Read more...} */ get visibleElements(): BasemapLayerListVisibleElements; set visibleElements(value: BasemapLayerListVisibleElementsProperties); /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#triggerAction Read more...} */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; on(name: "trigger-action", eventHandler: BasemapLayerListTriggerActionEventHandler): IHandle; } interface BasemapLayerListProperties extends WidgetProperties { /** * Specifies a function to handle filtering base layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseFilterPredicate Read more...} */ baseFilterPredicate?: BaseFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseFilterText Read more...} */ baseFilterText?: string; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing a base layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#baseListItemCreatedFunction Read more...} */ baseListItemCreatedFunction?: ListItemCreatedHandler | nullish; /** * The current basemap's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#basemapTitle Read more...} */ basemapTitle?: string | nullish; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} specific properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#catalogOptions Read more...} */ catalogOptions?: BasemapLayerListCatalogOptions | nullish; /** * Indicates whether the widget is collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#collapsed Read more...} */ collapsed?: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#dragEnabled Read more...} */ dragEnabled?: boolean; /** * Indicates whether the form to edit the basemap's title is currently visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#editingTitle Read more...} */ editingTitle?: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#filterPlaceholder Read more...} */ filterPlaceholder?: string; /** * Indicates the heading level to use for the widget title (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#label Read more...} */ label?: string; /** * The minimum number of list items required to display the visibleElements.filter input box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#minFilterItems Read more...} */ minFilterItems?: number; /** * Specifies a function to handle filtering reference layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceFilterPredicate Read more...} */ referenceFilterPredicate?: ReferenceFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceFilterText Read more...} */ referenceFilterText?: string; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing a reference layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#referenceListItemCreatedFunction Read more...} */ referenceListItemCreatedFunction?: ListItemCreatedHandler | nullish; /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing basemap layers * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#selectedItems Read more...} */ selectedItems?: CollectionProperties; /** * Specifies the selection mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#selectionMode Read more...} */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#viewModel Read more...} */ viewModel?: BasemapLayerListViewModelProperties; /** * Determines the icons used to indicate visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibilityAppearance Read more...} */ visibilityAppearance?: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#visibleElements Read more...} */ visibleElements?: BasemapLayerListVisibleElementsProperties; } export interface BasemapLayerListViewModel extends Accessor, Evented { } export class BasemapLayerListViewModel { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#baseLayers baseLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseItems Read more...} */ readonly baseItems: Collection; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseListItemCreatedFunction Read more...} */ baseListItemCreatedFunction: ListItemCreatedHandler | nullish; /** * The current basemap's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#basemapTitle Read more...} */ basemapTitle: string | nullish; /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html BasemapLayerList}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled: boolean; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html#referenceLayers referenceLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceItems Read more...} */ readonly referenceItems: Collection; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing reference layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceListItemCreatedFunction Read more...} */ referenceListItemCreatedFunction: ListItemCreatedHandler | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#state Read more...} */ readonly state: "ready" | "loading" | "disabled"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html BasemapLayerList} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-basemap-layer-list/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html Read more...} */ constructor(properties?: BasemapLayerListViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#triggerAction Read more...} */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; } interface BasemapLayerListViewModelProperties { /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#baseListItemCreatedFunction Read more...} */ baseListItemCreatedFunction?: ListItemCreatedHandler | nullish; /** * The current basemap's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#basemapTitle Read more...} */ basemapTitle?: string | nullish; /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html BasemapLayerList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled?: boolean; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled?: boolean; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} representing reference layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#referenceListItemCreatedFunction Read more...} */ referenceListItemCreatedFunction?: ListItemCreatedHandler | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList-BasemapLayerListViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export type BaseFilterPredicate = (item: ListItem) => void; export interface BasemapLayerListCatalogOptions { filterPlaceholder?: string; listItemCreatedFunction?: CatalogLayerListListItemCreatedHandler | nullish; minFilterItems?: number; selectionMode?: string; visibilityAppearance?: string; visibleElements?: BasemapLayerListCatalogOptionsVisibleElements; } export interface BasemapLayerListCatalogOptionsVisibleElements { errors?: boolean; filter?: boolean; statusIndicators?: boolean; temporaryLayerIndicators?: boolean; } export type ListItemCreatedHandler = (event: ListItemCreatedHandlerEvent) => void; export type ReferenceFilterPredicate = (item: ListItem) => void; export interface BasemapLayerListTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#VisibleElements Read more...} */ export interface BasemapLayerListVisibleElementsProperties { baseLayers?: boolean; closeButton?: boolean; collapseButton?: boolean; editTitleButton?: boolean; errors?: boolean; filter?: boolean; flow?: boolean; heading?: boolean; referenceLayers?: boolean; statusIndicators?: boolean; temporaryLayerIndicators?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapLayerList.html#VisibleElements Read more...} */ export interface BasemapLayerListVisibleElements extends AnonymousAccessor { baseLayers: boolean; closeButton: boolean; collapseButton: boolean; editTitleButton: boolean; errors: boolean; filter: boolean; flow: boolean; heading: boolean; referenceLayers: boolean; statusIndicators: boolean; temporaryLayerIndicators: boolean; } export interface ListItemCreatedHandlerEvent { item: ListItem; } export class BasemapToggle extends Widget { /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#activeBasemap Read more...} */ readonly activeBasemap: Basemap | nullish; /** * Icon which represents the widget. * * @default "layer-basemap" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#visibleElements Read more...} */ visibleElements: BasemapToggleVisibleElements; /** * The BasemapToggle provides a widget which allows an end-user to switch between * two basemaps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html Read more...} */ constructor(properties?: BasemapToggleProperties); /** * The next basemap for toggling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#nextBasemap Read more...} */ get nextBasemap(): Basemap | nullish; set nextBasemap(value: BasemapProperties | nullish | string); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#viewModel Read more...} */ get viewModel(): BasemapToggleViewModel; set viewModel(value: BasemapToggleViewModelProperties); /** * Toggles to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#nextBasemap next basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#toggle Read more...} */ toggle(): Promise; } interface BasemapToggleProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#label Read more...} */ label?: string; /** * The next basemap for toggling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#nextBasemap Read more...} */ nextBasemap?: BasemapProperties | nullish | string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#viewModel Read more...} */ viewModel?: BasemapToggleViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#visibleElements Read more...} */ visibleElements?: BasemapToggleVisibleElements; } export class BasemapToggleViewModel extends Accessor { /** * The map's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html#basemap basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#activeBasemap Read more...} */ readonly activeBasemap: Basemap | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#state Read more...} */ readonly state: "ready" | "incompatible-next-basemap" | "loading" | "disabled"; /** * The view from which the component or widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-basemap-toggle/ Basemap Toggle} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html BasemapToggle} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html Read more...} */ constructor(properties?: BasemapToggleViewModelProperties); /** * The next basemap for toggling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap Read more...} */ get nextBasemap(): Basemap | nullish; set nextBasemap(value: BasemapProperties | nullish | string); /** * Toggles to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap next basemap}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#toggle Read more...} */ toggle(): Promise; /** * Helper method to find a basemap's thumbnail URL. * * @param basemap The basemap used to retrieve the thumbnail URL. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#getThumbnailUrl Read more...} */ static getThumbnailUrl(basemap: Basemap | nullish): string | nullish; } interface BasemapToggleViewModelProperties { /** * The next basemap for toggling. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#nextBasemap Read more...} */ nextBasemap?: BasemapProperties | nullish | string; /** * The view from which the component or widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle-BasemapToggleViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BasemapToggle.html#VisibleElements Read more...} */ export interface BasemapToggleVisibleElements { title?: boolean; } export class BatchAttributeForm extends Widget { /** * The index of the active feature that is currently being edited. * * @default -1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#activeFeatureIndex Read more...} */ activeFeatureIndex: number; /** * Indicates if the widget is disabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#disabled Read more...} */ disabled: boolean; /** * The collection of features whose attributes are being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#features Read more...} */ features: Collection; /** * Defines how groups will be displayed to the user. * * @default "all" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#groupDisplay Read more...} */ groupDisplay: "all" | "sequential"; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#title title} of the form. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#headingLevel Read more...} */ headingLevel: number; /** * Icon displayed in the widget's button. * * @default "edit-attributes" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#icon Read more...} */ icon: string; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#map Read more...} */ map: Map | nullish; /** * Indicates whether the form is in a read-only state. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#readOnly Read more...} */ readOnly: boolean; /** * The time zone used to interpret date values in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#timeZone Read more...} */ timeZone: string | nullish; /** * Indicates whether there are validation errors for any fields for any features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#valid Read more...} */ readonly valid: boolean; /** * Defines which elements are visible in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#visibleElements Read more...} */ visibleElements: BatchAttributeFormVisibleElements; /** * The `BatchAttributeForm` widget enables users to edit the attributes of multiple features at once. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html Read more...} */ constructor(properties?: BatchAttributeFormProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#viewModel Read more...} */ get viewModel(): BatchAttributeFormViewModel; set viewModel(value: BatchAttributeFormViewModelProperties); /** * This method is typically called when the user clicks a submit button or when the form is programmatically submitted and calls the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#applyEdits FeatureLayer.applyEdits()} method * to update the features' attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#submit Read more...} */ submit(): void; on(name: "value-change", eventHandler: BatchAttributeFormValueChangeEventHandler): IHandle; on(name: "submit", eventHandler: BatchAttributeFormSubmitEventHandler): IHandle; } interface BatchAttributeFormProperties extends WidgetProperties { /** * The index of the active feature that is currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#activeFeatureIndex Read more...} */ activeFeatureIndex?: number; /** * Indicates if the widget is disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#disabled Read more...} */ disabled?: boolean; /** * The collection of features whose attributes are being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#features Read more...} */ features?: Collection; /** * Defines how groups will be displayed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#groupDisplay Read more...} */ groupDisplay?: "all" | "sequential"; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#title title} of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#icon Read more...} */ icon?: string; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#map Read more...} */ map?: Map | nullish; /** * Indicates whether the form is in a read-only state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#readOnly Read more...} */ readOnly?: boolean; /** * The time zone used to interpret date values in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#timeZone Read more...} */ timeZone?: string | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#viewModel Read more...} */ viewModel?: BatchAttributeFormViewModelProperties; /** * Defines which elements are visible in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#visibleElements Read more...} */ visibleElements?: BatchAttributeFormVisibleElements; } export interface BatchAttributeFormViewModel extends Accessor, Evented { } export class BatchAttributeFormViewModel { /** * The active feature in the form, which is the feature that is currently being edited while in `single`{@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#mode mode}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#activeFeature Read more...} */ readonly activeFeature: Graphic | nullish; /** * The index of the active feature that is currently being edited. * * @default -1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#activeFeatureIndex Read more...} */ activeFeatureIndex: number; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html batch attribute form inputs} that are currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#activeForm Read more...} */ readonly activeForm: BatchFormInputs; /** * Indicates whether the form is currently evaluating Arcade expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#calculating Read more...} */ readonly calculating: boolean; /** * Indicates whether the associated view should be in `read-only` mode. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#disabled Read more...} */ disabled: boolean; /** * The type of edit operation the form is being used for. * * @default "NA" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#editType Read more...} */ editType: "INSERT" | "UPDATE" | "DELETE" | "NA"; /** * Indicates whether any of the Arcade expressions in the form have * failed to evaluate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#expressionEvaluationFailed Read more...} */ readonly expressionEvaluationFailed: boolean; /** * The collection of features whose attributes are being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#features Read more...} */ features: Collection; /** * Indicates whether the form has too many features to be loaded * with forms containing complex {@link https://doc.geoscene.cn/javascript/4.33/arcade/ Arcade} expressions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#hasTooManyComplexFeatures Read more...} */ readonly hasTooManyComplexFeatures: boolean; /** * Indicates whether the form has too many features to be loaded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#hasTooManyFeatures Read more...} */ readonly hasTooManyFeatures: boolean; /** * Indicates whether there are any visible inputs in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#hasVisibleInputs Read more...} */ readonly hasVisibleInputs: boolean; /** * Returns an array of features that are invalid, meaning they have at least one invalid attribute value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#invalidFeatures Read more...} */ readonly invalidFeatures: Graphic[]; /** * An array of layers included in the batch attribute form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#layers Read more...} */ readonly layers: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | OrientedImageryLayer)[]; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#map Read more...} */ map: Map | nullish; /** * The mode of the form, which can be either `"single"` or `"batch"`. * * @default "batch" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#mode Read more...} */ readonly mode: "single" | "batch"; /** * Indicates whether the form is in a read-only state. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#readOnly Read more...} */ readOnly: boolean; /** * Indicates whether the view model is ready to be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#status Read more...} */ readonly status: "not-loaded" | "loading" | "failed" | "loaded"; /** * Indicates whether the user has attempted to submit the form. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#submitHasBeenAttempted Read more...} */ submitHasBeenAttempted: boolean; /** * The time zone used to interpret date values in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#timeZone Read more...} */ timeZone: string | nullish; /** * Indicates whether any values, for any features, have been modified by the * user. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#userHasChangedValues Read more...} */ userHasChangedValues: boolean; /** * Indicates whether there are any validation errors for any fields for any * features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#valid Read more...} */ readonly valid: boolean; /** * An array of visible inputs in the active form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#visibleInputs Read more...} */ readonly visibleInputs: (FieldInput | GroupInput)[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html Read more...} */ constructor(properties?: BatchAttributeFormViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Convenience method to find field inputs. * * @param elementId The elementId of the input field to find. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#findFieldInput Read more...} */ findFieldInput(elementId: string | nullish): any | nullish; /** * The method used to get the updated field value. * * @param elementId The id of the target field where the value is accessed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#getFieldInputValue Read more...} */ getFieldInputValue(elementId: string): any | nullish; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * This method triggers the `"submit"` event, and causes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#submitHasBeenAttempted submitHasBeenAttempted} to become `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#submit Read more...} */ submit(): void; on(name: "value-change", eventHandler: BatchAttributeFormViewModelValueChangeEventHandler): IHandle; on(name: "submit", eventHandler: BatchAttributeFormViewModelSubmitEventHandler): IHandle; } interface BatchAttributeFormViewModelProperties { /** * The index of the active feature that is currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#activeFeatureIndex Read more...} */ activeFeatureIndex?: number; /** * Indicates whether the associated view should be in `read-only` mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#disabled Read more...} */ disabled?: boolean; /** * The type of edit operation the form is being used for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#editType Read more...} */ editType?: "INSERT" | "UPDATE" | "DELETE" | "NA"; /** * The collection of features whose attributes are being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#features Read more...} */ features?: Collection; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#map Read more...} */ map?: Map | nullish; /** * Indicates whether the form is in a read-only state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#readOnly Read more...} */ readOnly?: boolean; /** * Indicates whether the user has attempted to submit the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#submitHasBeenAttempted Read more...} */ submitHasBeenAttempted?: boolean; /** * The time zone used to interpret date values in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#timeZone Read more...} */ timeZone?: string | nullish; /** * Indicates whether any values, for any features, have been modified by the * user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#userHasChangedValues Read more...} */ userHasChangedValues?: boolean; } export interface BatchAttributeFormViewModelSubmitEvent { name: "submit"; results: SubmitResult[]; valid: boolean; } /** * Describes the state of a single feature's attribute values at the time of a form submission. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html#SubmitResult Read more...} */ export interface SubmitResult { feature: Graphic; invalidFields: string[]; values: boolean; } export interface BatchAttributeFormViewModelValueChangeEvent { features: Graphic[]; fieldName: string; name: "value-change"; value: number | string | nullish; } export class BatchFormInputs extends Accessor { /** * Returns an array of all the field inputs in the form, including those in groups. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#allFieldInputs Read more...} */ readonly allFieldInputs: FieldInput[]; /** * The description for the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#description Read more...} */ readonly description: string | nullish; /** * An array of field or group inputs that make up the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#inputs Read more...} */ readonly inputs: (FieldInput | GroupInput)[]; /** * Returns an array of all features that have validation errors for one or more of the form inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#invalidFeatures Read more...} */ readonly invalidFeatures: Graphic[]; /** * Returns an array of all field inputs that have validation errors but are not visible in the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#invalidHiddenInputs Read more...} */ readonly invalidHiddenInputs: FieldInput[]; /** * The title of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#title Read more...} */ title: string | nullish; /** * Returns a boolean indicating whether all of the batch attribute form's field inputs are valid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#valid Read more...} */ readonly valid: boolean; /** * The `BatchFormInputs` class is a read-only class that acts as a container for a set of inputs in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-BatchAttributeFormViewModel.html BatchAttributeFormViewModel}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html Read more...} */ constructor(properties?: BatchFormInputsProperties); } interface BatchFormInputsProperties { /** * The title of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-BatchFormInputs.html#title Read more...} */ title?: string | nullish; } export class EditableInput { readonly editable: boolean; editType: "INSERT" | "UPDATE" | "DELETE" | "NA"; } interface EditableInputProperties { editType?: "INSERT" | "UPDATE" | "DELETE" | "NA"; } export interface FieldInput extends Accessor, InputBase, EditableInput { } export class FieldInput { /** * The type of data displayed by the field input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#dataType Read more...} */ readonly dataType: "number" | "text" | "date" | "unsupported"; /** * The input's description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#description Read more...} */ declare readonly description: InputBase["description"]; /** * Returns an array of distinct values of the field input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#distinctValues Read more...} */ readonly distinctValues: (number | string | nullish)[]; /** * The input value's domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#domain Read more...} */ readonly domain: CodedValueDomain | RangeDomain | InheritedDomain | nullish; /** * Indicates if the input is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#editable Read more...} */ declare readonly editable: EditableInput["editable"]; /** * The type of edit operation the form is being used for. * * @default "NA" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#editType Read more...} */ declare editType: EditableInput["editType"]; /** * Indicates whether the input pertains to all the features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm} in which the input belongs. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#existsInAllLayers Read more...} */ declare existsInAllLayers: InputBase["existsInAllLayers"]; /** * Indicates whether all features have the same value for this field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#featuresHaveSameValue Read more...} */ readonly featuresHaveSameValue: boolean; /** * The associated field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#field Read more...} */ readonly field: Field; /** * The field name as defined by the feature layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#fieldName Read more...} */ readonly fieldName: string; /** * The group containing the field input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#group Read more...} */ readonly group: GroupInput | nullish; /** * Indicates whether time information is included for date and time inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#includeTime Read more...} */ readonly includeTime: boolean; /** * Indicates whether timestamp information is included for date inputs. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#includeTimeOffset Read more...} */ readonly includeTimeOffset: boolean; /** * An array of features that do not have a valid value for this field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#invalidFeatures Read more...} */ readonly invalidFeatures: Graphic[]; /** * The input's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#label Read more...} */ declare readonly label: InputBase["label"]; /** * An array of layers included in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#layers Read more...} */ declare readonly layers: InputBase["layers"]; /** * Restricts the input length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#maxLength Read more...} */ readonly maxLength: number; /** * Restricts the input length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#minLength Read more...} */ readonly minLength: number; /** * Indicates whether the field is required. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#required Read more...} */ readonly required: boolean; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#type Read more...} */ readonly type: "field"; /** * Indicates whether the user has changed the value of this field. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#userHasChangedValue Read more...} */ readonly userHasChangedValue: boolean; /** * Indicates whether the field has any validation errors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#valid Read more...} */ readonly valid: boolean; /** * Indicates whether the input is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#visible Read more...} */ declare readonly visible: InputBase["visible"]; /** * This is a read-only support class that represents a field input in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html Read more...} */ constructor(properties?: FieldInputProperties); } interface FieldInputProperties extends InputBaseProperties, EditableInputProperties { /** * The type of edit operation the form is being used for. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#editType Read more...} */ editType?: EditableInputProperties["editType"]; /** * Indicates whether the input pertains to all the features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm} in which the input belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html#existsInAllLayers Read more...} */ existsInAllLayers?: InputBaseProperties["existsInAllLayers"]; } export interface GroupInput extends Accessor, InputBase { } export class GroupInput { /** * The input's description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#description Read more...} */ declare readonly description: InputBase["description"]; /** * Indicates whether the input pertains to all the features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm} in which the input belongs. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#existsInAllLayers Read more...} */ declare existsInAllLayers: InputBase["existsInAllLayers"]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-FieldInput.html field inputs} contained within the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#inputs Read more...} */ readonly inputs: ReadonlyArray; /** * The input's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#label Read more...} */ declare readonly label: InputBase["label"]; /** * An array of layers included in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#layers Read more...} */ declare readonly layers: InputBase["layers"]; /** * Indicates whether the group should be expanded or collapsed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#open Read more...} */ open: boolean; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#type Read more...} */ readonly type: "group"; /** * Indicates whether the input is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#visible Read more...} */ declare readonly visible: InputBase["visible"]; /** * This is a support class that represents a group of batch attribute form inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html Read more...} */ constructor(properties?: GroupInputProperties); } interface GroupInputProperties extends InputBaseProperties { /** * Indicates whether the input pertains to all the features in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html BatchAttributeForm} in which the input belongs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#existsInAllLayers Read more...} */ existsInAllLayers?: InputBaseProperties["existsInAllLayers"]; /** * Indicates whether the group should be expanded or collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm-inputs-GroupInput.html#open Read more...} */ open?: boolean; } export class InputBase { readonly description: string | nullish; existsInAllLayers: boolean; readonly label: string | nullish; readonly layers: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | OrientedImageryLayer)[]; readonly visible: boolean; } interface InputBaseProperties { existsInAllLayers?: boolean; } export interface BatchAttributeFormSubmitEvent { name: "submit"; results: SubmitResult[]; valid: boolean; } export interface BatchAttributeFormValueChangeEvent { features: Graphic[]; fieldName: string; name: "value-change"; value: number | string | nullish; } /** * An object containing properties that control the visibility of certain elements within the FeatureForm widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BatchAttributeForm.html#VisibleElements Read more...} */ export interface BatchAttributeFormVisibleElements { errorsForNonVisibleFields?: boolean; } export interface Bookmarks extends Widget, GoTo { } export class Bookmarks { /** * Specifies how new bookmarks will be created if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements visibleElements.addBookmarkButton} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#defaultCreateOptions Read more...} */ defaultCreateOptions: BookmarkOptions; /** * Specifies how bookmarks will be edited, if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements visibleElements.editBookmarkButton} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#defaultEditOptions Read more...} */ defaultEditOptions: BookmarkOptions; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#disabled Read more...} */ disabled: boolean; /** * Indicates if a Bookmark is able to be dragged in order to update its position in the list. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#dragEnabled Read more...} */ dragEnabled: boolean; /** * Defines the text used as a placeholder when visibleElements.filter is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#filterPlaceholder Read more...} */ filterPlaceholder: string; /** * Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#filterText Read more...} */ filterText: string; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates the heading level to use for the message "No bookmarks" when no bookmarks * are available in this widget. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "bookmark" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#label Read more...} */ label: string; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Bookmarks widget allows end users to quickly navigate to a particular area of interest. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html Read more...} */ constructor(properties?: BookmarksProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Bookmark}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#bookmarks Read more...} */ get bookmarks(): Collection; set bookmarks(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#viewModel Read more...} */ get viewModel(): BookmarksViewModel; set viewModel(value: BookmarksViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#visibleElements Read more...} */ get visibleElements(): BookmarksVisibleElements; set visibleElements(value: BookmarksVisibleElementsProperties); /** * Zoom to a specific bookmark. * * @param Bookmark The bookmark to zoom to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#goTo Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Bookmark}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#bookmarks Read more...} */ bookmarks?: CollectionProperties; /** * Specifies how new bookmarks will be created if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements visibleElements.addBookmarkButton} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#defaultCreateOptions Read more...} */ defaultCreateOptions?: BookmarkOptions; /** * Specifies how bookmarks will be edited, if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements visibleElements.editBookmarkButton} is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#defaultEditOptions Read more...} */ defaultEditOptions?: BookmarkOptions; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#disabled Read more...} */ disabled?: boolean; /** * Indicates if a Bookmark is able to be dragged in order to update its position in the list. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#dragEnabled Read more...} */ dragEnabled?: boolean; /** * Defines the text used as a placeholder when visibleElements.filter is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#filterPlaceholder Read more...} */ filterPlaceholder?: string; /** * Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#filterText Read more...} */ filterText?: string; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Indicates the heading level to use for the message "No bookmarks" when no bookmarks * are available in this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#label Read more...} */ label?: string; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#viewModel Read more...} */ viewModel?: BookmarksViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#visibleElements Read more...} */ visibleElements?: BookmarksVisibleElementsProperties; } export interface BookmarksViewModel extends Accessor, GoTo, Evented { } export class BookmarksViewModel { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Bookmark} that is being navigated to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#activeBookmark Read more...} */ readonly activeBookmark: Bookmark | nullish; /** * Defines the capabilities of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#capabilities Read more...} */ capabilities: BookmarksCapabilities; /** * Specifies how new bookmarks will be created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions Read more...} */ defaultCreateOptions: BookmarkOptions; /** * Specifies how bookmarks will be edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultEditOptions Read more...} */ defaultEditOptions: BookmarkOptions; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * The view model's state. * * @default "ready" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#state Read more...} */ readonly state: "loading" | "ready"; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html Bookmarks} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-bookmarks/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html Read more...} */ constructor(properties?: BookmarksViewModelProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Bookmark}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#bookmarks Read more...} */ get bookmarks(): Collection; set bookmarks(value: CollectionProperties); /** * Creates a new bookmark from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions defaultCreateOptions}, unless otherwise specified. * * @param options Specifies how new bookmarks will be created. Can be used to enable/disable taking screenshots or capturing the extent when a new bookmark is added. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#createBookmark Read more...} */ createBookmark(options?: BookmarkOptions): Promise; /** * Edits the given bookmark. * * @param bookmark The bookmark to be edited. * @param options Specifies how bookmarks will be edited. Can be used to enable/disable taking screenshots or capturing the extent when a bookmark is edited. If not specified, the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultEditOptions defaultEditOptions} will be used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#editBookmark Read more...} */ editBookmark(bookmark: Bookmark | nullish, options?: BookmarkOptions): Promise; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Zoom to a specific bookmark. * * @param bookmark The bookmark to zoom to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#goTo Read more...} */ goTo(bookmark: Bookmark): Promise; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; } interface BookmarksViewModelProperties extends GoToProperties { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webmap-Bookmark.html Bookmark}s. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#bookmarks Read more...} */ bookmarks?: CollectionProperties; /** * Defines the capabilities of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#capabilities Read more...} */ capabilities?: BookmarksCapabilities; /** * Specifies how new bookmarks will be created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultCreateOptions Read more...} */ defaultCreateOptions?: BookmarkOptions; /** * Specifies how bookmarks will be edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#defaultEditOptions Read more...} */ defaultEditOptions?: BookmarkOptions; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * Specifies how bookmarks will be created or modified. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions Read more...} */ export interface BookmarkOptions { takeScreenshot?: boolean; captureViewpoint?: boolean; captureRotation?: boolean; captureScale?: boolean; captureTimeExtent?: boolean; screenshotSettings?: BookmarkOptionsScreenshotSettings; } /** * Specifies the abilities for the Bookmarks widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks-BookmarksViewModel.html#BookmarksCapabilities Read more...} */ export interface BookmarksCapabilities { time?: boolean; } export interface BookmarkOptionsScreenshotSettings { width?: number; height?: number; area?: BookmarkOptionsScreenshotSettingsArea; layers?: Layer[]; } export interface BookmarkOptionsScreenshotSettingsArea { x: number; y: number; width: number; height: number; } export interface BookmarksBookmarkEditEvent { bookmark: Bookmark; } export interface BookmarksBookmarkSelectEvent { bookmark: Bookmark; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements Read more...} */ export interface BookmarksVisibleElementsProperties { addBookmarkButton?: boolean; closeButton?: boolean; collapseButton?: boolean; editBookmarkButton?: boolean; filter?: boolean; flow?: boolean; heading?: boolean; thumbnail?: boolean; time?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Bookmarks.html#VisibleElements Read more...} */ export interface BookmarksVisibleElements extends AnonymousAccessor { addBookmarkButton: boolean; closeButton: boolean; collapseButton: boolean; editBookmarkButton: boolean; filter: boolean; flow: boolean; heading: boolean; thumbnail: boolean; time: boolean; } export class BuildingExplorer extends Widget { /** * Indicates the heading level to use for the headings in the widget. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "organization" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#view Read more...} */ view: SceneView | nullish; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#visibleElements Read more...} */ visibleElements: BuildingExplorerVisibleElements; /** * The BuildingExplorer widget is used to filter and explore the various components of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html Read more...} */ constructor(properties?: BuildingExplorerProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html collection} of layers of type {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * that are added to the widget for exploration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#viewModel Read more...} */ get viewModel(): BuildingExplorerViewModel; set viewModel(value: BuildingExplorerViewModelProperties); } interface BuildingExplorerProperties extends WidgetProperties { /** * Indicates the heading level to use for the headings in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#label Read more...} */ label?: string; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html collection} of layers of type {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * that are added to the widget for exploration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#layers Read more...} */ layers?: CollectionProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#viewModel Read more...} */ viewModel?: BuildingExplorerViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#visibleElements Read more...} */ visibleElements?: BuildingExplorerVisibleElements; } export class BuildingExplorerViewModel extends Accessor { /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#level Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#phase Read more...} */ readonly phase: BuildingPhase; /** * The current state of the view model that can be used for rendering the UI of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state Read more...} */ readonly state: "disabled" | "loading" | "ready" | "failed"; /** * The view in which the BuildingExplorer is used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html BuildingExplorer} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-building-explorer/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html Read more...} */ constructor(properties?: BuildingExplorerViewModelProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html collection} of layers of type {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * that are added to the widget for exploration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#layers Read more...} */ get layers(): Collection; set layers(value: CollectionProperties); } interface BuildingExplorerViewModelProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html collection} of layers of type {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-BuildingSceneLayer.html BuildingSceneLayer} * that are added to the widget for exploration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#layers Read more...} */ layers?: CollectionProperties; /** * The view in which the BuildingExplorer is used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingExplorerViewModel.html#view Read more...} */ view?: SceneView | nullish; } export class BuildingLevel extends Accessor { /** * List of all the values which are allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#allowedValues Read more...} */ allowedValues: ReadonlyArray; /** * Whether the filter is enabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#enabled Read more...} */ readonly enabled: boolean; /** * Whether the next value can be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#hasNext Read more...} */ readonly hasNext: boolean; /** * Whether the previous value can be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#hasPrevious Read more...} */ readonly hasPrevious: boolean; /** * The maximum value allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#max Read more...} */ readonly max: number | nullish; /** * The minimum value allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#min Read more...} */ readonly min: number | nullish; /** * The value which is currently set on the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#value Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html Read more...} */ constructor(properties?: BuildingLevelProperties); /** * Removes the filter by setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#enabled enabled} to `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#clear Read more...} */ 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. * * @param value A filter value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#getValueLabel Read more...} */ getValueLabel(value: number): string | nullish; /** * Selects the next value, if available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#next Read more...} */ next(): void; /** * Selects the previous value, if available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#previous Read more...} */ previous(): void; /** * Selects the specified value for the filter. * * @param value The value which is to be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#select Read more...} */ select(value: number): void; } interface BuildingLevelProperties { /** * List of all the values which are allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingLevel.html#allowedValues Read more...} */ allowedValues?: ReadonlyArray; } export class BuildingPhase extends Accessor { /** * List of all the values which are allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#allowedValues Read more...} */ allowedValues: ReadonlyArray; /** * Whether the filter is enabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#enabled Read more...} */ readonly enabled: boolean; /** * Whether the next value can be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#hasNext Read more...} */ readonly hasNext: boolean; /** * Whether the previous value can be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#hasPrevious Read more...} */ readonly hasPrevious: boolean; /** * The maximum value allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#max Read more...} */ readonly max: number | nullish; /** * The minimum value allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#min Read more...} */ readonly min: number | nullish; /** * The value which is currently set on the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#value Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html Read more...} */ constructor(properties?: BuildingPhaseProperties); /** * Removes the filter by setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#enabled enabled} to `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#clear Read more...} */ 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. * * @param value A filter value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#getValueLabel Read more...} */ getValueLabel(value: number): string | nullish; /** * Selects the next value, if available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#next Read more...} */ next(): void; /** * Selects the previous value, if available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#previous Read more...} */ previous(): void; /** * Selects the specified value for the filter. * * @param value The value which is to be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#select Read more...} */ select(value: number): void; } interface BuildingPhaseProperties { /** * List of all the values which are allowed for the filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer-BuildingPhase.html#allowedValues Read more...} */ allowedValues?: ReadonlyArray; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-BuildingExplorer.html#VisibleElements Read more...} */ export interface BuildingExplorerVisibleElements { levels?: boolean; phases?: boolean; disciplines?: boolean; } export class CatalogLayerList extends Widget { /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItems} representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogLayer catalogLayer's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamicGroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogItems Read more...} */ readonly catalogItems: Collection; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} to display in the widget. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogLayer Read more...} */ catalogLayer: CatalogLayer | nullish; /** * Indicates whether the widget is collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#collapsed Read more...} */ collapsed: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterPlaceholder Read more...} */ filterPlaceholder: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterPredicate Read more...} */ filterPredicate: FilterPredicate | nullish; /** * The value of the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterText Read more...} */ filterText: string; /** * Indicates the heading level to use for the heading of the widget. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "catalog-dataset" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#label Read more...} */ label: string; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: CatalogLayerListListItemCreatedHandler | nullish; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#minFilterItems Read more...} */ minFilterItems: number; /** * Specifies the selection mode. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#selectionMode Read more...} */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Determines the icons used to indicate visibility. * * @default "default" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibilityAppearance Read more...} */ visibilityAppearance: "default" | "checkbox"; /** * The CatalogLayerList widget provides a way to display and interact with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html Read more...} */ constructor(properties?: CatalogLayerListProperties); /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItems} representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogItems catalogItems} * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#selectedItems Read more...} */ get selectedItems(): Collection; set selectedItems(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#viewModel Read more...} */ get viewModel(): CatalogLayerListViewModel; set viewModel(value: CatalogLayerListViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements Read more...} */ get visibleElements(): CatalogLayerListVisibleElements; set visibleElements(value: CatalogLayerListVisibleElementsProperties); /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param __0 The action to execute. * @param __1 An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#triggerAction Read more...} */ triggerAction(__0: ActionButton | ActionToggle, __1: ListItem): void; on(name: "trigger-action", eventHandler: CatalogLayerListTriggerActionEventHandler): IHandle; } interface CatalogLayerListProperties extends WidgetProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} to display in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogLayer Read more...} */ catalogLayer?: CatalogLayer | nullish; /** * Indicates whether the widget is collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#collapsed Read more...} */ collapsed?: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterPlaceholder Read more...} */ filterPlaceholder?: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterPredicate Read more...} */ filterPredicate?: FilterPredicate | nullish; /** * The value of the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#filterText Read more...} */ filterText?: string; /** * Indicates the heading level to use for the heading of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#label Read more...} */ label?: string; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: CatalogLayerListListItemCreatedHandler | nullish; /** * The minimum number of list items required to display the visibleElements.filter input box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#minFilterItems Read more...} */ minFilterItems?: number; /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItems} representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#catalogItems catalogItems} * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#selectedItems Read more...} */ selectedItems?: CollectionProperties; /** * Specifies the selection mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#selectionMode Read more...} */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#viewModel Read more...} */ viewModel?: CatalogLayerListViewModelProperties; /** * Determines the icons used to indicate visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibilityAppearance Read more...} */ visibilityAppearance?: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#visibleElements Read more...} */ visibleElements?: CatalogLayerListVisibleElementsProperties; } export interface CatalogLayerListViewModel extends Accessor, Evented { } export class CatalogLayerListViewModel { /** * The collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItems} representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#catalogLayer catalogLayer's} * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamicGroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#catalogItems Read more...} */ readonly catalogItems: Collection; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} to display in the widget. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#catalogLayer Read more...} */ catalogLayer: CatalogLayer | nullish; /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html CatalogLayerList}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled: boolean; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: CatalogLayerListViewModelListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#state Read more...} */ readonly state: "loading" | "ready" | "disabled"; /** * The view from which the widget will operate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html CatalogLayerList} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-catalog-layer-list/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html Read more...} */ constructor(properties?: CatalogLayerListViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param __0 The action to execute. * @param __1 An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#triggerAction Read more...} */ triggerAction(__0: ActionButton | ActionToggle, __1: ListItem): void; on(name: "trigger-action", eventHandler: CatalogLayerListViewModelTriggerActionEventHandler): IHandle; } interface CatalogLayerListViewModelProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} to display in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#catalogLayer Read more...} */ catalogLayer?: CatalogLayer | nullish; /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html CatalogLayerList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled?: boolean; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: CatalogLayerListViewModelListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled?: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList-CatalogLayerListViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export type CatalogLayerListViewModelListItemCreatedHandler = ( event: CatalogLayerListViewModelListItemCreatedHandlerEvent, ) => void; export interface CatalogLayerListViewModelTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } export interface CatalogLayerListViewModelListItemCreatedHandlerEvent { item: ListItem; } export type FilterPredicate = (item: ListItem) => void; export type CatalogLayerListListItemCreatedHandler = (event: CatalogLayerListListItemCreatedHandlerEvent) => void; export interface CatalogLayerListTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#VisibleElements Read more...} */ export interface CatalogLayerListVisibleElementsProperties { closeButton?: boolean; collapseButton?: boolean; errors?: boolean; filter?: boolean; flow?: boolean; heading?: boolean; statusIndicators?: boolean; temporaryLayerIndicators?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html#VisibleElements Read more...} */ export interface CatalogLayerListVisibleElements extends AnonymousAccessor { closeButton: boolean; collapseButton: boolean; errors: boolean; filter: boolean; flow: boolean; heading: boolean; statusIndicators: boolean; temporaryLayerIndicators: boolean; } export interface CatalogLayerListListItemCreatedHandlerEvent { item: ListItem; } export interface Compass extends Widget, GoTo { } export class Compass { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Icon displayed in the widget's button. * * @default "compass-needle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#label Read more...} */ label: string; /** * The view in which the Compass obtains and indicates camera * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading heading}, using a (SceneView) or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} (MapView). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Compass widget indicates where north is in relation to the current view * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading camera heading}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html Read more...} */ constructor(properties?: CompassProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#viewModel Read more...} */ get viewModel(): CompassViewModel; set viewModel(value: CompassViewModelProperties); /** * If working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, sets the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} to `0`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#reset Read more...} */ reset(): void; } interface CompassProperties extends WidgetProperties, GoToProperties { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#label Read more...} */ label?: string; /** * The view in which the Compass obtains and indicates camera * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading heading}, using a (SceneView) or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} (MapView). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html#viewModel Read more...} */ viewModel?: CompassViewModelProperties; } export interface CompassViewModel extends Accessor, GoTo { } export class CompassViewModel { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * The z axis orientation. * * @default { z: 0 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#orientation Read more...} */ readonly orientation: Orientation; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#state Read more...} */ readonly state: "compass" | "rotation" | "disabled"; /** * The view in which the Compass obtains and indicates camera * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading heading}, using a (SceneView) or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} (MapView). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass.html Compass} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-compass/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html Read more...} */ constructor(properties?: CompassViewModelProperties); /** * If working in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, sets the view's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} is to `0`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#reset Read more...} */ reset(): void; } interface CompassViewModelProperties extends GoToProperties { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The view in which the Compass obtains and indicates camera * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Camera.html#heading heading}, using a (SceneView) or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#rotation rotation} (MapView). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * The z axis orientation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Compass-CompassViewModel.html#Orientation Read more...} */ export interface Orientation { z?: number; } export interface CoordinateConversion extends Widget, GoTo { } export class CoordinateConversion { /** * Describes the location of the coordinates currently displayed by the widget as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#currentLocation Read more...} */ readonly currentLocation: Point | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates the heading level to use for the coordinate input and coordinate settings headings. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "coordinate-system" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#label Read more...} */ label: string; /** * Describes the current mode of the widget. * * @default "live" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#mode Read more...} */ mode: "live" | "capture"; /** * If this property is set to `true`, multiple conversions can be displayed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#multipleConversions Read more...} */ multipleConversions: boolean; /** * Determines whether the widget should expand up or down. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#orientation Read more...} */ orientation: "auto" | "expand-up" | "expand-down"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageType storageType}) * will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageEnabled Read more...} */ storageEnabled: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageType Read more...} */ storageType: "session" | "local"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#visibleElements Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html Read more...} */ constructor(properties?: CoordinateConversionProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html Conversion} * that the widget is currently displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#conversions Read more...} */ get conversions(): Collection; set conversions(value: CollectionProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} * that the widget is capable of displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#formats Read more...} */ get formats(): Collection; set formats(value: CollectionProperties); /** * This symbol is used to visualize the location currently described by the widget when `capture` mode * is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#locationSymbol Read more...} */ get locationSymbol(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; set locationSymbol(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" })); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#viewModel Read more...} */ get viewModel(): CoordinateConversionViewModel; set viewModel(value: CoordinateConversionViewModelProperties); /** * Attempt to convert a string into a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * @param coordinate The coordinate string. * @param format Specifies the format of the input coordinate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#reverseConvert Read more...} */ reverseConvert(coordinate: string, format: Format): Promise; } interface CoordinateConversionProperties extends WidgetProperties, GoToProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html Conversion} * that the widget is currently displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#conversions Read more...} */ conversions?: CollectionProperties; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} * that the widget is capable of displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#formats Read more...} */ formats?: CollectionProperties; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Indicates the heading level to use for the coordinate input and coordinate settings headings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#label Read more...} */ label?: string; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode * is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#locationSymbol Read more...} */ locationSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * Describes the current mode of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#mode Read more...} */ mode?: "live" | "capture"; /** * If this property is set to `true`, multiple conversions can be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#multipleConversions Read more...} */ multipleConversions?: boolean; /** * Determines whether the widget should expand up or down. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#orientation Read more...} */ orientation?: "auto" | "expand-up" | "expand-down"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageType storageType}) * will be used to hydrate and persist the CoordinateConversion widget's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageEnabled Read more...} */ storageEnabled?: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#storageType Read more...} */ storageType?: "session" | "local"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#viewModel Read more...} */ viewModel?: CoordinateConversionViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#visibleElements Read more...} */ visibleElements?: CoordinateConversionVisibleElements; } export interface CoordinateConversionViewModel extends Accessor, GoTo { } export class CoordinateConversionViewModel { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Describes the current mode of the widget. * * @default "live" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode Read more...} */ mode: "live" | "capture"; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#state Read more...} */ readonly state: "ready" | "loading" | "disabled"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType storageType}) * will be used to hydrate and persist the CoordinateConversion widget's state. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageEnabled Read more...} */ storageEnabled: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * @default "session" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType Read more...} */ storageType: "session" | "local"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html CoordinateConversion} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-coordinate-conversion/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html Read more...} */ constructor(properties?: CoordinateConversionViewModelProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html Conversion} * that the widget is currently displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions Read more...} */ get conversions(): Collection; set conversions(value: CollectionProperties); /** * Describes the location of the coordinates currently displayed by the widget as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation Read more...} */ get currentLocation(): Point | nullish; set currentLocation(value: PointProperties | nullish); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} * that the widget is capable of displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats Read more...} */ get formats(): Collection; set formats(value: CollectionProperties); /** * This symbol is used to visualize the location currently described by the widget when `capture` mode * is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol Read more...} */ get locationSymbol(): SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | CIMSymbol; set locationSymbol(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" })); /** * Attempt to convert a point into a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position Position}. * * @param format The format that describes how the point should be converted. * @param point The point to convert. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#convert Read more...} */ convert(format: Format, point: Point): Promise; /** * Attempt to convert a string into a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * @param coordinate The coordinate string. * @param format Specifies the format of the input coordinate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#reverseConvert Read more...} */ reverseConvert(coordinate: string, format: Format): Promise; /** * Update the input conversions based on the input point. * * @param conversions An array of [Conversions](geoscene-widgets-CoordinateConversion-support-Conversion.html) to be updated. * @param location A point that will be used to update each input conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#updateConversions Read more...} */ updateConversions(conversions: Conversion[], location: Point | nullish): Promise; } interface CoordinateConversionViewModelProperties extends GoToProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html Conversion} * that the widget is currently displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#conversions Read more...} */ conversions?: CollectionProperties; /** * Describes the location of the coordinates currently displayed by the widget as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#currentLocation Read more...} */ currentLocation?: PointProperties | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} containing every {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} * that the widget is capable of displaying. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#formats Read more...} */ formats?: CollectionProperties; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * This symbol is used to visualize the location currently described by the widget when `capture` mode * is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#locationSymbol Read more...} */ locationSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * Describes the current mode of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#mode Read more...} */ mode?: "live" | "capture"; /** * If this property is set to `true`, sessionStorage or localStorage (depending on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType storageType}) * will be used to hydrate and persist the CoordinateConversion widget's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageEnabled Read more...} */ storageEnabled?: boolean; /** * This property determines whether sessionStorage or localStorage will be used to store widget state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#storageType Read more...} */ storageType?: "session" | "local"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * Describes a point in terms of a location, a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, and a coordinate, a string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-CoordinateConversionViewModel.html#Position Read more...} */ export interface Position { location: Point | nullish; coordinate: string | nullish; } export class Conversion extends Accessor { /** * A formatted string based on the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#position position} and display information on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#format format}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#displayCoordinate Read more...} */ readonly displayCoordinate: string | nullish; /** * The position property contains the location information for this conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#position Read more...} */ position: ConversionPosition | nullish; /** * The Conversion class represents one of the [conversions](geoscene-widgets-CoordinateConversion.html#conversions) * in the [Coordinate Conversion widget](geoscene-widgets-CoordinateConversion.html). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html Read more...} */ constructor(properties?: ConversionProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} for this conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#format Read more...} */ get format(): Format | nullish; set format(value: FormatProperties | nullish); } interface ConversionProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Format} for this conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#format Read more...} */ format?: FormatProperties | nullish; /** * The position property contains the location information for this conversion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#position Read more...} */ position?: ConversionPosition | nullish; } /** * Describes a point in terms of a location, a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, and a coordinate, a string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Conversion.html#Position Read more...} */ export interface ConversionPosition { location: Point | nullish; coordinate: string | nullish; } export class Format extends Accessor { /** * Contains information that describes how this Format should be converted. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#conversionInfo Read more...} */ conversionInfo: ConversionInfo | nullish; /** * A array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#CoordinateSegment Coordinate Segments}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#coordinateSegments Read more...} */ coordinateSegments: CoordinateSegment[] | nullish; /** * A string that serves as a pattern describing how this Format should be displayed. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#currentPattern Read more...} */ currentPattern: string; /** * The default pattern describing how this Format should be displayed. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#defaultPattern Read more...} */ defaultPattern: string | nullish; /** * A string that is used to label this Format in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#label Read more...} */ label: string; /** * The name of the coordinate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#name Read more...} */ name: string | nullish; /** * The view model of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html CoordinateConversion} widget that is utilizing this format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#viewModel Read more...} */ viewModel: CoordinateConversionViewModel | nullish; /** * The Format class represents one of the [formats](geoscene-widgets-CoordinateConversion.html#formats) * in the [Coordinate Conversion widget](geoscene-widgets-CoordinateConversion.html). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html Read more...} */ constructor(properties?: FormatProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} for this format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#spatialReference Read more...} */ get spatialReference(): SpatialReference; set spatialReference(value: SpatialReferenceProperties); } interface FormatProperties { /** * Contains information that describes how this Format should be converted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#conversionInfo Read more...} */ conversionInfo?: ConversionInfo | nullish; /** * A array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#CoordinateSegment Coordinate Segments}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#coordinateSegments Read more...} */ coordinateSegments?: CoordinateSegment[] | nullish; /** * A string that serves as a pattern describing how this Format should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#currentPattern Read more...} */ currentPattern?: string; /** * The default pattern describing how this Format should be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#defaultPattern Read more...} */ defaultPattern?: string | nullish; /** * A string that is used to label this Format in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#label Read more...} */ label?: string; /** * The name of the coordinate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#name Read more...} */ name?: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html SpatialReference} for this format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties; /** * The view model of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html CoordinateConversion} widget that is utilizing this format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#viewModel Read more...} */ viewModel?: CoordinateConversionViewModel | nullish; } /** * This object describes how a Format should be projected and formatted for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#ConversionInfo Read more...} */ export interface ConversionInfo { convert?: ConvertFunction; reverseConvert?: ReverseConvertFunction; } export type ConvertFunction = (point: Point | nullish) => FormatPosition; /** * A coordinate segment represents one piece of a coordinate string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#CoordinateSegment Read more...} */ export interface CoordinateSegment { alias: string; description: string; searchPattern: RegExp; } /** * Describes a point in terms of a location, a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point}, and a coordinate, a string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion-support-Format.html#Position Read more...} */ export interface FormatPosition { location: Point | nullish; coordinate: string | nullish; } export type ReverseConvertFunction = (coordinate: string) => Point; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CoordinateConversion.html#VisibleElements Read more...} */ export interface CoordinateConversionVisibleElements { settingsButton?: boolean; inputButton?: boolean; expandButton?: boolean; captureButton?: boolean; } export class Daylight extends Widget { /** * Controls whether the widget displays a date or a season picker. * * @default "date" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#dateOrSeason Read more...} */ dateOrSeason: "season" | "date"; /** * Indicates the heading level to use for the widget title. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "brightness" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#label Read more...} */ label: string; /** * Controls the speed of the daytime and date animation. * * @default 1.0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#playSpeedMultiplier Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#timeSliderSteps Read more...} */ timeSliderSteps: number | number[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#view Read more...} */ view: SceneView | nullish; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#visibleElements Read more...} */ visibleElements: DaylightVisibleElements; /** * The Daylight widget can be used to manipulate the lighting conditions * of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html Read more...} */ constructor(properties?: DaylightProperties); /** * The view model for the Daylight widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#viewModel Read more...} */ get viewModel(): DaylightViewModel; set viewModel(value: DaylightViewModelProperties); on(name: "user-date-time-change", eventHandler: DaylightUserDateTimeChangeEventHandler): IHandle; } interface DaylightProperties extends WidgetProperties { /** * Controls whether the widget displays a date or a season picker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#dateOrSeason Read more...} */ dateOrSeason?: "season" | "date"; /** * Indicates the heading level to use for the widget title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#label Read more...} */ label?: string; /** * Controls the speed of the daytime and date animation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#playSpeedMultiplier Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#timeSliderSteps Read more...} */ timeSliderSteps?: number | number[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for the Daylight widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#viewModel Read more...} */ viewModel?: DaylightViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#visibleElements Read more...} */ visibleElements?: DaylightVisibleElements; } export interface DaylightViewModel extends Accessor, Evented { } export class DaylightViewModel { /** * A season can be set instead of a date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#currentSeason Read more...} */ currentSeason: "spring" | "summer" | "fall" | "winter"; /** * Starts or pauses the daytime animation cycling through the minutes of the day. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#dayPlaying Read more...} */ dayPlaying: boolean; /** * Indicates whether to show shadows cast by the sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#directShadowsEnabled Read more...} */ directShadowsEnabled: boolean; /** * Controls the daytime and date animation speed. * * @default 1.0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#playSpeedMultiplier Read more...} */ playSpeedMultiplier: number; /** * Indicates whether date and time are used to determine position of the light source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#sunLightingEnabled Read more...} */ sunLightingEnabled: boolean; /** * Slider position for the time of day in the timezone * given by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset utcOffset}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#timeSliderPosition Read more...} */ timeSliderPosition: number; /** * The difference in hours between UTC time and the time displayed in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset Read more...} */ utcOffset: number; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Starts or pauses the date animation cycling through the months of the year. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#yearPlaying Read more...} */ yearPlaying: boolean; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html Daylight} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-daylight/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html Read more...} */ constructor(properties?: DaylightViewModelProperties); /** * The calendar date in the timezone given by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset utcOffset}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#localDate Read more...} */ get localDate(): Date; set localDate(value: DateProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; on(name: "user-date-time-change", eventHandler: DaylightViewModelUserDateTimeChangeEventHandler): IHandle; } interface DaylightViewModelProperties { /** * A season can be set instead of a date. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#currentSeason Read more...} */ currentSeason?: "spring" | "summer" | "fall" | "winter"; /** * Starts or pauses the daytime animation cycling through the minutes of the day. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#dayPlaying Read more...} */ dayPlaying?: boolean; /** * Indicates whether to show shadows cast by the sun. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#directShadowsEnabled Read more...} */ directShadowsEnabled?: boolean; /** * The calendar date in the timezone given by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset utcOffset}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#localDate Read more...} */ localDate?: DateProperties; /** * Controls the daytime and date animation speed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#playSpeedMultiplier Read more...} */ playSpeedMultiplier?: number; /** * Indicates whether date and time are used to determine position of the light source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#sunLightingEnabled Read more...} */ sunLightingEnabled?: boolean; /** * Slider position for the time of day in the timezone * given by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset utcOffset}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#timeSliderPosition Read more...} */ timeSliderPosition?: number; /** * The difference in hours between UTC time and the time displayed in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#utcOffset Read more...} */ utcOffset?: number; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#view Read more...} */ view?: SceneView | nullish; /** * Starts or pauses the date animation cycling through the months of the year. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight-DaylightViewModel.html#yearPlaying Read more...} */ yearPlaying?: boolean; } export interface DaylightViewModelUserDateTimeChangeEvent { } export interface DaylightUserDateTimeChangeEvent { } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Daylight.html#VisibleElements Read more...} */ export interface DaylightVisibleElements { header?: boolean; playButtons?: boolean; datePicker?: boolean; timezone?: boolean; sunLightingToggle?: boolean; shadowsToggle?: boolean; } export class DirectionalPad extends Widget { /** * Indicates whether interaction is allowed on the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#disabled Read more...} */ disabled: boolean; /** * Icon which represents the widget. * * @default "move" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#label Read more...} */ label: string; /** * The view which the directional pad will control. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#view Read more...} */ view: MapView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#visibleElements Read more...} */ visibleElements: DirectionalPadVisibleElements; /** * Determines the size of directional pad buttons and the slider. * * @default "s" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#visualScale Read more...} */ visualScale: "s" | "m" | "l"; /** * A directional pad (D-Pad) widget can be used to control the position and rotation * of the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html Read more...} */ constructor(properties?: DirectionalPadProperties); /** * The view model for the DirectionalPad widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#viewModel Read more...} */ get viewModel(): DirectionalPadViewModel; set viewModel(value: DirectionalPadViewModelProperties); } interface DirectionalPadProperties extends WidgetProperties { /** * Indicates whether interaction is allowed on the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#disabled Read more...} */ disabled?: boolean; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#label Read more...} */ label?: string; /** * The view which the directional pad will control. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#view Read more...} */ view?: MapView | nullish; /** * The view model for the DirectionalPad widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#viewModel Read more...} */ viewModel?: DirectionalPadViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#visibleElements Read more...} */ visibleElements?: DirectionalPadVisibleElements; /** * Determines the size of directional pad buttons and the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#visualScale Read more...} */ visualScale?: "s" | "m" | "l"; } export class DirectionalPadViewModel extends Accessor { /** * The closest angle that matches the current mouse position * relative to the widget's center. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#angle Read more...} */ readonly angle: number | nullish; /** * Indicates whether interaction is allowed on the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#disabled Read more...} */ disabled: boolean; /** * The angle of rotation of the map. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#rotation Read more...} */ rotation: number; /** * The state of the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "moving"; /** * The view which the directional pad will control. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html DirectionalPad} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-directional-pad/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html Read more...} */ 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. * * @param pointerLocation Current pointer location * @param widgetCenter The center of the DirectionalPad widget * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#beginFollowingPointer Read more...} */ beginFollowingPointer(pointerLocation: Vector, widgetCenter: Vector): void; /** * Initialize a brief movement in a desired direction. * * @param angle Angle in the [0, 360] range * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#moveOnce Read more...} */ moveOnce(angle: number): void; } interface DirectionalPadViewModelProperties { /** * Indicates whether interaction is allowed on the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#disabled Read more...} */ disabled?: boolean; /** * The angle of rotation of the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#rotation Read more...} */ rotation?: number; /** * The view which the directional pad will control. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * An x/y coordinate pair. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad-DirectionalPadViewModel.html#Vector Read more...} */ export interface Vector { x?: number; y?: number; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectionalPad.html#VisibleElements Read more...} */ export interface DirectionalPadVisibleElements { directionalButtons?: boolean; rotationSlider?: boolean; rotationResetButton?: boolean; } export interface Directions extends Widget, GoTo { } export class Directions { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#apiKey Read more...} */ apiKey: string | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates the heading level to use for the origin and destination addresses (i.e. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "right" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#label Read more...} */ label: string; /** * The most recent route result. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#lastRoute Read more...} */ readonly lastRoute: DirectionsLastRoute | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} associated with the Directions widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#layer Read more...} */ layer: RouteLayer | nullish; /** * The maximum number of stops allowed for routing. * * @default 50 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#maxStops Read more...} */ maxStops: number; /** * Controls the default properties used when searching. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#searchProperties Read more...} */ searchProperties: DirectionsSearchProperties | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#visibleElements Read more...} */ visibleElements: DirectionsVisibleElements; /** * The Directions widget provides a way to calculate directions, between two or more input locations with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer}, * using GeoScene Online and custom Network Analysis Route services. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html Read more...} */ constructor(properties?: DirectionsProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#viewModel Read more...} */ get viewModel(): DirectionsViewModel; set viewModel(value: DirectionsViewModelProperties); /** * Computes a route and directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#getDirections Read more...} */ getDirections(): Promise; /** * Saves the RouteLayer associated with the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#save Read more...} */ save(): Promise; /** * Saves the RouteLayer associated with the view model as a new portal item. * * @param portalItem The new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} to which the layer will be saved. * @param options Save options. Currently, there is only one property that can be set, which is `folder`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: DirectionsSaveAsOptions): Promise; /** * Zoom so that the full route is displayed within the current map extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#zoomToRoute Read more...} */ zoomToRoute(): void; } interface DirectionsProperties extends WidgetProperties, GoToProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#apiKey Read more...} */ apiKey?: string | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Indicates the heading level to use for the origin and destination addresses (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#label Read more...} */ label?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} associated with the Directions widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#layer Read more...} */ layer?: RouteLayer | nullish; /** * The maximum number of stops allowed for routing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#maxStops Read more...} */ maxStops?: number; /** * Controls the default properties used when searching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#searchProperties Read more...} */ searchProperties?: DirectionsSearchProperties | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#viewModel Read more...} */ viewModel?: DirectionsViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#visibleElements Read more...} */ visibleElements?: DirectionsVisibleElements; } export interface DirectionsViewModel extends Accessor, GoTo { } export class DirectionsViewModel { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#apiKey Read more...} */ apiKey: string | nullish; /** * When `true`, the assigned route layer will automatically solve whenever the stops or barriers (if any) are edited. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#autoSolve Read more...} */ autoSolve: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * The network attribute name to be used as the impedance attribute in the analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#impedanceAttribute Read more...} */ readonly impedanceAttribute: DirectionsViewModelImpedanceAttribute | nullish; /** * The most recent route result. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#lastRoute Read more...} */ readonly lastRoute: DirectionsViewModelLastRoute | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} associated with the DirectionsViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#layer Read more...} */ layer: RouteLayer | nullish; /** * The maximum number of stops allowed for routing. * * @default 50 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#maxStops Read more...} */ maxStops: number; /** * The Service Description object returned by the Route REST Endpoint. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#serviceDescription Read more...} */ readonly serviceDescription: ServiceDescription | nullish; /** * The current state of the view model. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "error" | "initializing" | "routing" | "unauthenticated"; /** * The name of the network attribute to use for the drive time when computing directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#timeAttribute Read more...} */ readonly timeAttribute: DirectionsViewModelTimeAttribute | nullish; /** * An array of available {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-TravelMode.html travel modes} from the associated * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#layer RouteLayer}'s routing service (see {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html#url RouteLayer.url}). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#travelModes Read more...} */ readonly travelModes: TravelMode[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the communication and data manipulation logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html Directions} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-directions/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html Read more...} */ constructor(properties?: DirectionsViewModelProperties); /** * Route Parameters object used to call the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#routeParameters Read more...} */ get routeParameters(): RouteParameters; set routeParameters(value: RouteParametersProperties); /** * The travel mode that will be used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#getDirections getDirections()} * when requesting the route and directions. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#selectedTravelMode Read more...} */ get selectedTravelMode(): TravelMode | nullish; set selectedTravelMode(value: TravelModeProperties | nullish); /** * Centers the map at the specified maneuver or stop. * * @param stopOrManeuver The stop or maneuver where the map should be centered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#centerAt Read more...} */ centerAt(stopOrManeuver: Graphic | nullish): void; /** * Clears any highlighted route segments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#clearHighlights Read more...} */ clearHighlights(): void; /** * Removes the route directions from the directions list, leaving the inputs untouched. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#clearResults Read more...} */ clearResults(): void; /** * Returns the cost attribute associated with the parsed name. * * @param attributeName The attribute name specifying the cost attribute used as an impedance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#getCostAttribute Read more...} */ getCostAttribute(attributeName: string): any | nullish; /** * Computes a route and directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#getDirections Read more...} */ getDirections(): Promise; /** * Highlights the specified network feature. * * @param networkFeature The network feature to highlight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#highlight Read more...} */ highlight(networkFeature: | DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop): Promise; /** * This method should be called to load the view model's routing resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#load Read more...} */ load(): Promise; /** * Resets the state of the ViewModel, clearing all the input stops and results in the widget and in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#reset Read more...} */ reset(): void; /** * Saves the RouteLayer associated with the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#save Read more...} */ save(): Promise; /** * Saves the RouteLayer associated with the view model as a new portal item. * * @param portalItem The new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item} to which the layer will be saved. * @param options Save options. Currently, there is only one property that can be set, which is `folder`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#saveAs Read more...} */ saveAs(portalItem: PortalItem, options?: DirectionsViewModelSaveAsOptions): Promise; /** * Zoom so that the full route is displayed within the current map extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#zoomToRoute Read more...} */ zoomToRoute(): void; } interface DirectionsViewModelProperties extends GoToProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#apiKey Read more...} */ apiKey?: string | nullish; /** * When `true`, the assigned route layer will automatically solve whenever the stops or barriers (if any) are edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#autoSolve Read more...} */ autoSolve?: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-RouteLayer.html RouteLayer} associated with the DirectionsViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#layer Read more...} */ layer?: RouteLayer | nullish; /** * The maximum number of stops allowed for routing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#maxStops Read more...} */ maxStops?: number; /** * Route Parameters object used to call the service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#routeParameters Read more...} */ routeParameters?: RouteParametersProperties; /** * The travel mode that will be used by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#getDirections getDirections()} * when requesting the route and directions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#selectedTravelMode Read more...} */ selectedTravelMode?: TravelModeProperties | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions-DirectionsViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export interface DirectionsViewModelImpedanceAttribute { name: string | nullish; units: string | nullish; } export interface DirectionsViewModelLastRoute extends RouteLayerSolveResult { directionLines: Collection; directionPoints: Collection; pointBarriers: Collection; polygonBarriers: Collection; polylineBarriers: Collection; routeInfo: RouteInfo; stops: Collection; } export interface DirectionsViewModelSaveAsOptions { folder?: PortalFolder; } export interface DirectionsViewModelTimeAttribute { name: string | nullish; units: string | nullish; } export interface DirectionsLastRoute extends RouteLayerSolveResult { directionLines: Collection; directionPoints: Collection; pointBarriers: Collection; polygonBarriers: Collection; polylineBarriers: Collection; routeInfo: RouteInfo; stops: Collection; } export interface DirectionsSaveAsOptions { folder?: PortalFolder; } /** * Configurable Search properties of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#SearchProperties Read more...} */ export interface DirectionsSearchProperties { activeSourceIndex?: number; allPlaceholder?: string; autoNavigate?: boolean; autoSelect?: boolean; includeDefaultSources?: boolean | Function; locationType?: string; maxResults?: number; maxSuggestions?: number; minSuggestCharacters?: number; popupEnabled?: boolean; popupTemplate?: PopupTemplate; resultGraphicEnabled?: boolean; searchAllEnabled?: boolean; searchTerm?: string; sources?: Collection; suggestionsEnabled?: boolean; view?: MapView | SceneView; viewModel?: SearchViewModel; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Directions.html#VisibleElements Read more...} */ export interface DirectionsVisibleElements { editRouteButton?: boolean; layerDetails?: boolean; printButton?: boolean; saveAsButton?: boolean; saveButton?: boolean; } export class DirectLineMeasurement3D extends Widget { /** * Icon which represents the widget. * * @default "measure-line" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#view Read more...} */ view: SceneView | nullish; /** * The DirectLineMeasurement3D widget calculates and displays the 3D distance between two points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html Read more...} */ constructor(properties?: DirectLineMeasurement3DProperties); /** * The direct line measurement analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#analysis Read more...} */ get analysis(): DirectLineMeasurementAnalysis; set analysis(value: DirectLineMeasurementAnalysisProperties & { type: "direct-line-measurement" }); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#viewModel Read more...} */ get viewModel(): DirectLineMeasurement3DViewModel; set viewModel(value: DirectLineMeasurement3DViewModelProperties); } interface DirectLineMeasurement3DProperties extends WidgetProperties { /** * The direct line measurement analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#analysis Read more...} */ analysis?: DirectLineMeasurementAnalysisProperties & { type: "direct-line-measurement" }; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#label Read more...} */ label?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html#viewModel Read more...} */ viewModel?: DirectLineMeasurement3DViewModelProperties; } export class DirectLineMeasurement3DViewModel extends Accessor { /** * The current measurement calculated between the two points. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#measurement Read more...} */ readonly measurement: DirectLineMeasurement3DViewModelMeasurement | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit Read more...} */ unit: SystemOrLengthUnit | nullish; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[] | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D.html DirectLineMeasurement3D} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-direct-line-measurement-3d/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html Read more...} */ constructor(properties?: DirectLineMeasurement3DViewModelProperties); /** * The direct line measurement analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#analysis Read more...} */ get analysis(): DirectLineMeasurementAnalysis; set analysis(value: DirectLineMeasurementAnalysisProperties & { type: "direct-line-measurement" }); /** * Clears the current measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#clear Read more...} */ clear(): void; /** * Starts a new measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#start Read more...} */ start(): void; } interface DirectLineMeasurement3DViewModelProperties { /** * The direct line measurement analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#analysis Read more...} */ analysis?: DirectLineMeasurementAnalysisProperties & { type: "direct-line-measurement" }; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unit Read more...} */ unit?: SystemOrLengthUnit | nullish; /** * List of unit systems (imperial, metric) and specific units for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[] | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#view Read more...} */ view?: SceneView | nullish; } export interface DirectLineMeasurement3DViewModelMeasurement { mode: "euclidean" | "geodesic"; directDistance: DirectLineMeasurement3DViewModelMeasurementValue; horizontalDistance: DirectLineMeasurement3DViewModelMeasurementValue; verticalDistance: DirectLineMeasurement3DViewModelMeasurementValue; } /** * Measurement value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.html#MeasurementValue Read more...} */ export interface DirectLineMeasurement3DViewModelMeasurementValue { text: string | nullish; state: string; } export class DistanceMeasurement2D extends Widget { /** * Icon which represents the widget. * * @default "measure-line" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#view Read more...} */ view: MapView | nullish; /** * The DistanceMeasurement2D widget calculates and displays the distance between two or more points * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html Read more...} */ constructor(properties?: DistanceMeasurement2DProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#viewModel Read more...} */ get viewModel(): DistanceMeasurement2DViewModel; set viewModel(value: DistanceMeasurement2DViewModelProperties); } interface DistanceMeasurement2DProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#label Read more...} */ label?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html#viewModel Read more...} */ viewModel?: DistanceMeasurement2DViewModelProperties; } export class DistanceMeasurement2DViewModel extends Accessor { /** * The length and geometry of the measurement polyline in meters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurement Read more...} */ readonly measurement: DistanceMeasurement2DViewModelMeasurement | nullish; /** * This property returns the locale specific representation of the length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#measurementLabel Read more...} */ readonly measurementLabel: string | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D.html DistanceMeasurement2D} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-distance-measurement-2d/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html Read more...} */ constructor(properties?: DistanceMeasurement2DViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Clears the current measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#clear Read more...} */ clear(): void; /** * Starts a new measurement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#start Read more...} */ start(): void; } interface DistanceMeasurement2DViewModelProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[]; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-DistanceMeasurement2D-DistanceMeasurement2DViewModel.html#view Read more...} */ view?: MapView | nullish; } export interface DistanceMeasurement2DViewModelMeasurement { length: number; geometry: any; } export class Editor extends Widget { /** * A property indicating the current active workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#activeWorkflow Read more...} */ readonly activeWorkflow: CreateFeaturesWorkflow | UpdateWorkflow | UpdateFeaturesWorkflow | nullish; /** * Indicates the heading level to use for title of the widget. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "pencil" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#label Read more...} */ label: string; /** * An array of editing configurations for individual layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#layerInfos Read more...} */ layerInfos: EditorLayerInfo[] | nullish; /** * This property allows customization of supporting Editor widgets and their default behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#supportingWidgetDefaults Read more...} */ supportingWidgetDefaults: SupportingWidgetDefaults | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#view Read more...} */ view: MapView | SceneView | nullish; /** * This widget provides an out-of-the-box editing experience to help streamline editing within a web application. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Read more...} */ constructor(properties?: EditorProperties); /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#labelOptions Read more...} */ get labelOptions(): SketchLabelOptions; set labelOptions(value: SketchLabelOptionsProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#tooltipOptions Read more...} */ get tooltipOptions(): SketchTooltipOptions; set tooltipOptions(value: SketchTooltipOptionsProperties); /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#valueOptions Read more...} */ get valueOptions(): SketchValueOptions; set valueOptions(value: SketchValueOptionsProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#viewModel Read more...} */ get viewModel(): EditorViewModel; set viewModel(value: EditorViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#visibleElements Read more...} */ get visibleElements(): EditorVisibleElements; set visibleElements(value: EditorVisibleElementsProperties); /** * Cancels any active workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#cancelWorkflow Read more...} */ cancelWorkflow(): Promise; /** * This is applicable if there is an active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#deleteAssociationFromWorkflow Read more...} */ deleteAssociationFromWorkflow(): Promise; /** * This is applicable if there is an active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow}. * * @deprecated since version 4.33. Use [`deleteFeatures`](#deletefeatures) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#deleteFeatureFromWorkflow Read more...} */ deleteFeatureFromWorkflow(): Promise; /** * If the active workflow is an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflow.html UpdateFeaturesWorkflow}, this method * deletes the feature(s) associated with the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#deleteFeatures Read more...} */ deleteFeatures(): Promise; /** * Initiates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} by displaying the panel where feature(s) creation begins. * * @param creationInfo An object containing information needed to create a new feature using the Editor widget. This object provides the feature template and layer for creating a new feature or features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureCreation Read more...} */ startCreateFeaturesWorkflowAtFeatureCreation(creationInfo: CreateFeaturesCreationInfo): Promise; /** * This method starts the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} at the "creating-features" step with the provided feature. * * @param params Parameters object containing an `initialFeature` to use in the associated CreateFeaturesWorkflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureEdit Read more...} */ startCreateFeaturesWorkflowAtFeatureEdit(params: EditorStartCreateFeaturesWorkflowAtFeatureEditParams): Promise; /** * Initiates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} by displaying the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startCreateFeaturesWorkflowAtFeatureTypeSelection Read more...} */ startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise; /** * Starts an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflow.html UpdateFeaturesWorkflow} using * the provided features. * * @param features The features to batch update * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startUpdateFeaturesWorkflow Read more...} */ startUpdateFeaturesWorkflow(features: Graphic[]): Promise; /** * Starts the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow} at the attribute editing panel. * * @param feature The feature to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startUpdateWorkflowAtFeatureEdit Read more...} */ startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise; /** * Starts the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow} using the current selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startUpdateWorkflowAtFeatureSelection Read more...} */ startUpdateWorkflowAtFeatureSelection(): Promise; /** * This method starts the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow} where it waits for multiple features * to be selected. * * @param candidates An array of features to be updated. This is only relevant when there are multiple candidates to update. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#startUpdateWorkflowAtMultipleFeatureSelection Read more...} */ startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): Promise; on(name: "sketch-create", eventHandler: EditorSketchCreateEventHandler): IHandle; on(name: "sketch-update", eventHandler: EditorSketchUpdateEventHandler): IHandle; } interface EditorProperties extends WidgetProperties { /** * Indicates the heading level to use for title of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#label Read more...} */ label?: string; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#labelOptions Read more...} */ labelOptions?: SketchLabelOptionsProperties; /** * An array of editing configurations for individual layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#layerInfos Read more...} */ layerInfos?: EditorLayerInfo[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for editing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * This property allows customization of supporting Editor widgets and their default behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#supportingWidgetDefaults Read more...} */ supportingWidgetDefaults?: SupportingWidgetDefaults | nullish; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#tooltipOptions Read more...} */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#valueOptions Read more...} */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#viewModel Read more...} */ viewModel?: EditorViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#visibleElements Read more...} */ visibleElements?: EditorVisibleElementsProperties; } export class CreateFeaturesWorkflow extends Workflow { /** * Indicates the current feature state during creation. * * @default "create-new" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html#createFeatureState Read more...} */ readonly createFeatureState: "create-new" | "update-pending"; /** * The shared workflow data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html#data Read more...} */ readonly data: CreateFeaturesWorkflowData; /** * Returns the number of pending features of an active {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html#numPendingFeatures Read more...} */ readonly numPendingFeatures: number; /** * Returns a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing features that are currently pending in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html CreateFeaturesWorkflowData}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html#pendingFeatures Read more...} */ readonly pendingFeatures: ReadonlyCollection; /** * A read-only class containing the logic used when creating features using * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html Read more...} */ constructor(properties?: CreateFeaturesWorkflowProperties); /** * Moves the pending feature into update mode. * * @param feature The pending feature to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html#updatePendingFeature Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#creationInfo Read more...} */ creationInfo: CreationInfo | nullish; /** * The full version of the template referenced by the property * `creationInfo.template`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#fullTemplate Read more...} */ fullTemplate: FeatureTemplate | SharedTemplate | nullish; /** * Returns a collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} representing features that have been created during the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#pendingFeatures Read more...} */ readonly pendingFeatures: ReadonlyCollection; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html EditorViewModel} for this workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#viewModel Read more...} */ viewModel: EditorViewModel; /** * This object supports the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html Read more...} */ constructor(properties?: CreateFeaturesWorkflowDataProperties); } interface CreateFeaturesWorkflowDataProperties { /** * This provides the feature template and layer when creating a new feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#creationInfo Read more...} */ creationInfo?: CreationInfo | nullish; /** * The full version of the template referenced by the property * `creationInfo.template`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#fullTemplate Read more...} */ fullTemplate?: FeatureTemplate | SharedTemplate | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html EditorViewModel} for this workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflowData.html#viewModel Read more...} */ viewModel?: EditorViewModel; } export class EditorViewModel extends Accessor { /** * A property indicating the current active workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#activeWorkflow Read more...} */ readonly activeWorkflow: CreateFeaturesWorkflow | UpdateWorkflow | UpdateFeaturesWorkflow | nullish; /** * Convenience property that indicates at least one layer supports a `create-features` workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#canCreate Read more...} */ readonly canCreate: boolean; /** * Convenience property that indicates at least one layer supports a `update` workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#canUpdate Read more...} */ readonly canUpdate: boolean; /** * A predominantly read-only collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html editor items} that corresponds to the feature being updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#editorItems Read more...} */ readonly editorItems: Collection; /** * An array of objects containing information specific to any failed editing operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#failures Read more...} */ readonly failures: EditorViewModelFailures[]; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html FeatureFormViewModel} * for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#featureFormViewModel Read more...} */ readonly featureFormViewModel: FeatureFormViewModel | nullish; /** * The form's view model used to support the Editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#formViewModel Read more...} */ readonly formViewModel: BatchAttributeFormViewModel | FeatureFormViewModel | nullish; /** * An array of editing configurations for individual layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#layerInfos Read more...} */ layerInfos: EditorLayerInfo[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html SketchViewModel} * for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#sketchViewModel Read more...} */ readonly sketchViewModel: SketchViewModel | nullish; /** * The widget's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#state Read more...} */ readonly state: | "add-association-create-association" | "add-association-select-feature" | "add-association-select-layer" | "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-features" | "ready" | "viewing-selection-list"; /** * Indicates if there is at least one edit request being processed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#syncing Read more...} */ readonly syncing: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-editor/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html Read more...} */ constructor(properties?: EditorViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html AttachmentsViewModel} for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#attachmentsViewModel Read more...} */ get attachmentsViewModel(): AttachmentsViewModel; set attachmentsViewModel(value: AttachmentsViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html FeatureTemplatesViewModel} * for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#featureTemplatesViewModel Read more...} */ get featureTemplatesViewModel(): FeatureTemplatesViewModel; set featureTemplatesViewModel(value: FeatureTemplatesViewModelProperties); /** * Options to configure the labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#labelOptions Read more...} */ get labelOptions(): SketchLabelOptions; set labelOptions(value: SketchLabelOptionsProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#tooltipOptions Read more...} */ get tooltipOptions(): SketchTooltipOptions; set tooltipOptions(value: SketchTooltipOptionsProperties); /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#valueOptions Read more...} */ get valueOptions(): SketchValueOptions; set valueOptions(value: SketchValueOptionsProperties); /** * Cancels any active workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#cancelWorkflow Read more...} */ cancelWorkflow(): Promise; /** * This is applicable if there is an active update workflow with an active * child workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#deleteAssociationFromWorkflow Read more...} */ deleteAssociationFromWorkflow(): Promise; /** * This is applicable if there is an active update workflow with an active * child workflow. * * @deprecated since version 4.33. Use [`deleteFeatures`](#deletefeatures) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#deleteFeatureFromWorkflow Read more...} */ deleteFeatureFromWorkflow(): Promise; /** * If the active workflow is an * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html UpdateWorkflow} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflow.html UpdateFeaturesWorkflow}, this method * deletes the feature(s) associated with the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#deleteFeatures Read more...} */ deleteFeatures(): Promise; /** * Get all of the editing templates associated with a given layer. * * @param layer The layer whose templates should be retrieved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#getTemplatesForLayer Read more...} */ getTemplatesForLayer(layer: GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer): (FeatureTemplate | SharedTemplateMetadata)[]; /** * Initiates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} by displaying the panel where feature creation begins. * * @param creationInfo An object containing information needed to create a new feature using the Editor widget. This object provides the feature template and layer for creating a new feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureCreation Read more...} */ startCreateFeaturesWorkflowAtFeatureCreation(creationInfo: CreateFeaturesCreationInfo): Promise; /** * This method starts the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} at the "creating-features" step with the provided feature. * * @param params Parameters object containing an `initialFeature` to use in the associated CreateFeaturesWorkflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureEdit Read more...} */ startCreateFeaturesWorkflowAtFeatureEdit(params: EditorViewModelStartCreateFeaturesWorkflowAtFeatureEditParams): Promise; /** * Initiates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html CreateFeaturesWorkflow} by displaying the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startCreateFeaturesWorkflowAtFeatureTypeSelection Read more...} */ startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise; /** * Starts an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflow.html UpdateFeaturesWorkflow} using * the provided features. * * @param features The features to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startUpdateFeaturesWorkflow Read more...} */ startUpdateFeaturesWorkflow(features: Graphic[]): Promise; /** * Starts the update workflow at the feature geometry and attribute editing panel. * * @param feature The feature to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtFeatureEdit Read more...} */ startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise; /** * Starts the `update` workflow using the current selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtFeatureSelection Read more...} */ startUpdateWorkflowAtFeatureSelection(): Promise; /** * Starts the Editor workflow where it waits for multiple features * to be selected. * * @param candidates The selected feature candidates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#startUpdateWorkflowAtMultipleFeatureSelection Read more...} */ startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): Promise; /** * Toggles the `UpdateWorkflow`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#toggleUpdateWorkflow Read more...} */ toggleUpdateWorkflow(): void; on(name: "sketch-create", eventHandler: EditorViewModelSketchCreateEventHandler): IHandle; on(name: "sketch-update", eventHandler: EditorViewModelSketchUpdateEventHandler): IHandle; } interface EditorViewModelProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Attachments-AttachmentsViewModel.html AttachmentsViewModel} for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#attachmentsViewModel Read more...} */ attachmentsViewModel?: AttachmentsViewModelProperties; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html FeatureTemplatesViewModel} * for supporting the editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#featureTemplatesViewModel Read more...} */ featureTemplatesViewModel?: FeatureTemplatesViewModelProperties; /** * Options to configure the labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#labelOptions Read more...} */ labelOptions?: SketchLabelOptionsProperties; /** * An array of editing configurations for individual layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#layerInfos Read more...} */ layerInfos?: EditorLayerInfo[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#tooltipOptions Read more...} */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#valueOptions Read more...} */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export interface EditorViewModelFailures { error: Error; } export interface EditorViewModelStartCreateFeaturesWorkflowAtFeatureEditParams { 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Edits.html#feature Read more...} */ readonly feature: Graphic | nullish; /** * When true, the feature has been modified from its original state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Edits.html#modified Read more...} */ readonly modified: boolean; /** * This class supports the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Edits.html Read more...} */ constructor(properties?: EditsProperties); } interface EditsProperties { } export class EditorItem extends Accessor { /** * The current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#EditorEditingCapabilities editing capabilities} for the provided layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#capabilities Read more...} */ readonly capabilities: EditorEditingCapabilities; /** * Indicates whether to override {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#editable editable} to `false`. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#disabled Read more...} */ disabled: boolean; /** * Indicates whether at least one edit operation is supported in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#capabilities capabilities}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#editable Read more...} */ readonly editable: boolean; /** * A reference to the primary {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} in use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#formTemplate Read more...} */ readonly formTemplate: FormTemplate | nullish; /** * Indicates whether the primary {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html FormTemplate} has an unknown (invalid) field. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#hasInvalidFormTemplate Read more...} */ readonly hasInvalidFormTemplate: boolean; /** * Indicates whether the associated layer is of type `Table`. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#isTable Read more...} */ isTable: boolean; /** * The layer currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#layer Read more...} */ layer: GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#LayerInfo layerInfo} for the provided layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#layerInfo Read more...} */ layerInfo: EditorLayerInfo | nullish; /** * Indicates whether the item supports starting a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-CreateFeaturesWorkflow.html create features} workflow based on specific conditions set within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#supportsCreateFeaturesWorkflow Read more...} */ readonly supportsCreateFeaturesWorkflow: boolean; /** * Indicates whether the item supports starting a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html update workflow} based on specific conditions set within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#supportsUpdateWorkflow Read more...} */ readonly supportsUpdateWorkflow: boolean; /** * Indicates whether the associated layer and its parent are visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#visible Read more...} */ readonly visible: boolean; /** * A predominantly read-only editable item that corresponds to the feature being updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html Read more...} */ constructor(properties?: EditorItemProperties); } interface EditorItemProperties { /** * Indicates whether to override {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#editable editable} to `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#disabled Read more...} */ disabled?: boolean; /** * Indicates whether the associated layer is of type `Table`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#isTable Read more...} */ isTable?: boolean; /** * The layer currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#layer Read more...} */ layer?: GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#LayerInfo layerInfo} for the provided layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#layerInfo Read more...} */ layerInfo?: EditorLayerInfo | nullish; } /** * The editing capabilities for attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#AttachmentCapabilities Read more...} */ export interface AttachmentCapabilities { enabled: boolean; } /** * Specific permissions for create operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#CreateCapabilities Read more...} */ export interface CreateCapabilities { attachments: AttachmentCapabilities; attributes: boolean; enabled: boolean; geometry: boolean; reliesOnOwnerAdminPrivileges: boolean; } /** * The default editing capabilities for the provided layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#DefaultEditingCapabilities Read more...} */ export interface DefaultEditingCapabilities { attachments: AttachmentCapabilities; create: CreateCapabilities; delete: DeleteCapabilities; layer: GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; reliesOnOwnerAdminPrivileges: boolean; update: UpdateCapabilities; } /** * Specific permissions for delete operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#DeleteCapabilities Read more...} */ export interface DeleteCapabilities { enabled: boolean; reliesOnOwnerAdminPrivileges: boolean; } /** * The current editing capabilities for the provided layer and read by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#EditorEditingCapabilities Read more...} */ export interface EditorEditingCapabilities { attachments: AttachmentCapabilities; create: CreateCapabilities; defaults: DefaultEditingCapabilities; delete: DeleteCapabilities; formTemplate: FormTemplate | nullish; layer: GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; layerInfo: EditorLayerInfo | nullish; relationship: RelationshipCapabilities; reliesOnOwnerAdminPrivileges: boolean; update: UpdateCapabilities; } /** * Specific permissions for relationship operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#RelationshipCapabilities Read more...} */ export interface RelationshipCapabilities { enabled: boolean; } /** * Specific permissions for update operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-support-EditorItem.html#UpdateCapabilities Read more...} */ export interface UpdateCapabilities { attachments: AttachmentCapabilities; attributes: boolean; enabled: boolean; geometry: boolean; reliesOnOwnerAdminPrivileges: boolean; } export class UpdateFeaturesWorkflow extends Workflow { constructor(properties?: UpdateFeaturesWorkflowProperties); } interface UpdateFeaturesWorkflowProperties extends WorkflowProperties { } export class UpdateFeaturesWorkflowData { /** * The `EditorItem` objects from `EditorViewModel` corresponding to the * layers/tables being updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflowData.html#editorItems Read more...} */ editorItems: EditorItem[]; /** * The features that are being updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflowData.html#features Read more...} */ features: Graphic[]; /** * The selected feature being updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflowData.html#selectedFeature Read more...} */ selectedFeature: Graphic | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html EditorViewModel} for this workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateFeaturesWorkflowData.html#viewModel Read more...} */ viewModel: EditorViewModel; constructor(properties?: any); } export class UpdateWorkflow extends Workflow { /** * The shared workflow data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html#data Read more...} */ readonly data: UpdateWorkflowData; /** * The type of workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html#type Read more...} */ readonly type: "update"; /** * A read-only class containing the logic used when updating and/or deleting features using * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflow.html Read more...} */ constructor(properties?: UpdateWorkflowProperties); } interface UpdateWorkflowProperties extends WorkflowProperties { } export class UpdateWorkflowData extends Accessor { /** * An array of features to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflowData.html#candidates Read more...} */ candidates: Graphic[]; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html EditorViewModel} for this workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflowData.html#viewModel Read more...} */ viewModel: EditorViewModel; /** * This object supports the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html Editor} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflowData.html Read more...} */ constructor(properties?: UpdateWorkflowDataProperties); } interface UpdateWorkflowDataProperties { /** * An array of features to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflowData.html#candidates Read more...} */ candidates?: Graphic[]; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-EditorViewModel.html EditorViewModel} for this workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-UpdateWorkflowData.html#viewModel Read more...} */ viewModel?: EditorViewModel; } export class Workflow extends Accessor { /** * The shared workflow data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#data Read more...} */ readonly data: CreateFeaturesWorkflowData | UpdateWorkflowData | UpdateFeaturesWorkflowData; /** * This property indicates whether there is a next step in the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#hasNextStep Read more...} */ readonly hasNextStep: boolean; /** * This property indicates if there is a previous step in the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#hasPreviousStep Read more...} */ readonly hasPreviousStep: boolean; /** * Indicates whether the workflow is considered active. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#started Read more...} */ readonly started: boolean; /** * The name of the current step in the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#stepId Read more...} */ readonly stepId: string; /** * Value indicating the workflow type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#type Read more...} */ readonly type: | "add-association" | "create-features" | "update" | "update-feature" | "update-features" | "update-table-record"; /** * The read-only `Workflow` class helps manage different stages of an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html editing} workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html Read more...} */ constructor(properties?: WorkflowProperties); /** * Cancels the active workflow. * * @param options An object with the following properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#cancel Read more...} */ cancel(options?: WorkflowCancelOptions): Promise; /** * Call this method when the workflow is considered finished. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#commit Read more...} */ commit(): Promise; /** * Moves to the next step in the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#next Read more...} */ next(): Promise; /** * Moves to the previous step in the workflow. * * @param options Options when calling this method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#previous Read more...} */ previous(options?: WorkflowPreviousOptions): Promise; /** * Resets the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#reset Read more...} */ reset(): Promise; /** * Starts the workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor-Workflow.html#start Read more...} */ start(): Promise; } interface WorkflowProperties { } export interface WorkflowCancelOptions { error?: Error; force?: boolean; emitCancelEvent?: boolean; } export interface WorkflowPreviousOptions { cancelCurrentStep: boolean; } /** * This object provides required properties needed when creating a new feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#CreateFeaturesCreationInfo Read more...} */ export interface CreateFeaturesCreationInfo { layer: FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; template: FeatureTemplate; } /** * This object provides required and optional properties needed when creating a new feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#CreationInfo Read more...} */ export interface CreationInfo { layer: FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; template?: FeatureTemplate | SharedTemplateMetadata; geometryToPlace?: Mesh | nullish; maxFeatures?: number; initialFeature?: Graphic; } export interface EditorStartCreateFeaturesWorkflowAtFeatureEditParams { initialFeature: Graphic; } /** * Configurations used for setting the layer's editable preferences within the Editor. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#LayerInfo Read more...} */ export interface EditorLayerInfo { layer: FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; enabled?: boolean; addEnabled?: boolean; updateEnabled?: boolean; deleteEnabled?: boolean; attributeUpdatesEnabled?: boolean; attachmentsOnCreateEnabled?: boolean; attachmentsOnUpdateEnabled?: boolean; geometryUpdatesEnabled?: boolean; formTemplate?: FormTemplate; } export interface EditorSketchCreateEvent { detail: EditorSketchCreateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; type: "sketch-create"; } export interface EditorSketchUpdateEvent { detail: EditorSketchUpdateEventDetail; layer: FeatureLayer | SceneLayer | SubtypeSublayer; type: "sketch-update"; } /** * Set this to customize any supporting Editor widget's default behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#SupportingWidgetDefaults Read more...} */ export interface SupportingWidgetDefaults { attachments?: SupportingWidgetDefaultsAttachments; featureForm?: SupportingWidgetDefaultsFeatureForm; featureTemplates?: SupportingWidgetDefaultsFeatureTemplates; sketch?: SupportingWidgetDefaultsSketch; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#VisibleElements Read more...} */ export interface EditorVisibleElementsProperties { createFeaturesSection?: boolean; editFeaturesSection?: boolean; labelsToggle?: boolean; tooltipsToggle?: boolean; settingsMenu?: boolean; flow?: boolean; sketch?: boolean; undoRedoButtons?: boolean; snappingControls?: boolean; snappingControlsElements?: VisibleElementsSnappingControlsElementsProperties; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Editor.html#VisibleElements Read more...} */ export interface EditorVisibleElements extends AnonymousAccessor { get snappingControlsElements(): VisibleElementsSnappingControlsElements; set snappingControlsElements(value: VisibleElementsSnappingControlsElementsProperties); createFeaturesSection: boolean; editFeaturesSection: boolean; labelsToggle: boolean; tooltipsToggle: boolean; settingsMenu: boolean; flow: boolean; sketch: boolean; undoRedoButtons: boolean; snappingControls: boolean; } 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"; toolEventInfo: UpdateToolEventInfo; type: "update"; } export interface SupportingWidgetDefaultsAttachments { displayType?: string; capabilities?: AttachmentsCapabilities; } export interface SupportingWidgetDefaultsFeatureForm { groupDisplay?: string; } export interface SupportingWidgetDefaultsFeatureTemplates { groupBy?: string | GroupByFunction | nullish; visibleElements?: SupportingWidgetDefaultsFeatureTemplatesVisibleElements; enableListScroll?: boolean; } export interface SupportingWidgetDefaultsFeatureTemplatesVisibleElements { filter?: boolean; } export interface SupportingWidgetDefaultsSketch { defaultUpdateOptions?: any; pointSymbol?: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol; polygonSymbol?: SimpleFillSymbol | CIMSymbol | PolygonSymbol3D; polylineSymbol?: SimpleLineSymbol | CIMSymbol | LineSymbol3D; } export interface VisibleElementsSnappingControlsElementsProperties { header?: boolean; enabledToggle?: boolean; selfEnabledToggle?: boolean; featureEnabledToggle?: boolean; layerList?: boolean; layerListToggleLayersButton?: boolean; gridEnabledToggle?: boolean; gridControls?: boolean; gridControlsElements?: VisibleElementsSnappingControlsElementsGridControlsElementsProperties; } export interface VisibleElementsSnappingControlsElements extends AnonymousAccessor { get gridControlsElements(): VisibleElementsSnappingControlsElementsGridControlsElements; set gridControlsElements(value: VisibleElementsSnappingControlsElementsGridControlsElementsProperties); header: boolean; enabledToggle: boolean; selfEnabledToggle: boolean; featureEnabledToggle: boolean; layerList: boolean; layerListToggleLayersButton: boolean; gridEnabledToggle: boolean; gridControls: boolean; } export interface VisibleElementsSnappingControlsElementsGridControlsElementsProperties { gridSnapEnabledToggle?: boolean; gridEnabledToggle?: boolean; colorSelection?: boolean; dynamicScaleToggle?: boolean; rotateWithMapToggle?: boolean; numericInputs?: boolean; lineIntervalInput?: boolean; placementButtons?: boolean; outOfScaleWarning?: boolean; } export interface VisibleElementsSnappingControlsElementsGridControlsElements extends AnonymousAccessor { gridSnapEnabledToggle: boolean; gridEnabledToggle: boolean; colorSelection: boolean; dynamicScaleToggle: boolean; rotateWithMapToggle: boolean; numericInputs: boolean; lineIntervalInput: boolean; placementButtons: boolean; outOfScaleWarning: boolean; } export class ElevationProfile extends Widget { /** * Icon which represents the widget. * * @default "altitude" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#view Read more...} */ view: SceneView | MapView | nullish; /** * The ElevationProfile widget is used to generate and display an elevation profile from an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#input input line graphic}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html Read more...} */ constructor(properties?: ElevationProfileProperties); /** * The input line graphic along which elevation will be queried in order to generate an elevation profile. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#input Read more...} */ get input(): Graphic | nullish; set input(value: GraphicProperties | nullish); /** * Collection of elevation profile lines which are to be generated and displayed in the widget's * chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#profiles Read more...} */ get profiles(): Collection< ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView >; set profiles(value: CollectionProperties< | (ElevationProfileLineGroundProperties & { type: "ground" }) | (ElevationProfileLineInputProperties & { type: "input" }) | (ElevationProfileLineQueryProperties & { type: "query" }) | (ElevationProfileLineViewProperties & { type: "view" }) >); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#viewModel Read more...} */ get viewModel(): ElevationProfileViewModel; set viewModel(value: ElevationProfileViewModelProperties); /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#visibleElements Read more...} */ get visibleElements(): ElevationProfileVisibleElements; set visibleElements(value: ElevationProfileVisibleElementsProperties); } interface ElevationProfileProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#icon Read more...} */ icon?: string; /** * The input line graphic along which elevation will be queried in order to generate an elevation profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#input Read more...} */ input?: GraphicProperties | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#label Read more...} */ label?: string; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's * chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#profiles Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#view Read more...} */ view?: SceneView | MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#viewModel Read more...} */ viewModel?: ElevationProfileViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#visibleElements Read more...} */ visibleElements?: ElevationProfileVisibleElementsProperties; } export class ElevationProfileLine extends Accessor { /** * Point being hovered in the chart, in the view's spatial reference. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#hoveredPoint Read more...} */ readonly hoveredPoint: Point | nullish; /** * Unique identifier for the profile line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#id Read more...} */ id: string; /** * How far along the generation of this profile is. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#progress Read more...} */ readonly progress: number; /** * List of samples that make up the elevation profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#samples Read more...} */ readonly samples: ElevationProfileSample[] | nullish; /** * Statistics about the generated elevation profile, if available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#statistics Read more...} */ readonly statistics: ElevationProfileStatistics | nullish; /** * Title of the line, to be displayed in the chart tooltip and in the chart legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#title Read more...} */ title: string | nullish; /** * The line type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#type Read more...} */ readonly type: "ground" | "input" | "query" | "view"; /** * Whether a line visualization representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#samples elevationSamples} * should be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#viewVisualizationEnabled Read more...} */ viewVisualizationEnabled: boolean; /** * Whether the line should be computed and shown in the chart. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#visible Read more...} */ visible: boolean; /** * Common interface for all the elevation profile lines. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html Read more...} */ constructor(properties?: ElevationProfileLineProperties); /** * Color of the line on the chart and the hovered points in the view. * * @default "#000000" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); } interface ElevationProfileLineProperties { /** * Color of the line on the chart and the hovered points in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#color Read more...} */ color?: ColorProperties; /** * Unique identifier for the profile line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#id Read more...} */ id?: string; /** * Title of the line, to be displayed in the chart tooltip and in the chart legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#title Read more...} */ title?: string | nullish; /** * Whether a line visualization representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#samples elevationSamples} * should be added to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#viewVisualizationEnabled Read more...} */ viewVisualizationEnabled?: boolean; /** * Whether the line should be computed and shown in the chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#visible Read more...} */ visible?: boolean; } /** * Represents an elevation sample in the profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileSample Read more...} */ export interface ElevationProfileSample { x: number; y: number; z?: number | nullish; distance: number; elevation?: number | nullish; } /** * Represents the statistics for the generated profile line. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLine.html#ElevationProfileStatistics Read more...} */ export interface ElevationProfileStatistics { maxDistance: number | nullish; minElevation: number | nullish; maxElevation: number | nullish; avgElevation: number | nullish; elevationGain: number | nullish; elevationLoss: number | nullish; maxPositiveSlope: number | nullish; avgPositiveSlope: number | nullish; maxNegativeSlope: number | nullish; avgNegativeSlope: number | nullish; } export class ElevationProfileLineGround extends ElevationProfileLine { /** * The line type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineGround.html#type Read more...} */ readonly type: "ground"; /** * Profile line which samples elevation from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html Ground} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map} currently set in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineGround.html Read more...} */ constructor(properties?: ElevationProfileLineGroundProperties); } interface ElevationProfileLineGroundProperties extends ElevationProfileLineProperties { } export class ElevationProfileLineInput extends ElevationProfileLine { /** * The line type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineInput.html#type Read more...} */ readonly type: "input"; /** * Profile line which samples elevation from the geometry of the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} * itself, typically used on input lines with z values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineInput.html Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineQuery.html#source Read more...} */ source: ElevationProfileLineQuerySource; /** * The line type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineQuery.html#type Read more...} */ readonly type: "query"; /** * Profile line which samples elevation from a custom elevation source, for example by creating a new * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayer}, or by using an elevation layer from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html#layers ground.layers}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineQuery.html Read more...} */ constructor(properties?: ElevationProfileLineQueryProperties); } interface ElevationProfileLineQueryProperties extends ElevationProfileLineProperties { /** * Elevation source used to sample elevation when generating the profile, for * example an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ElevationLayer.html ElevationLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineQuery.html#source Read more...} */ source?: ElevationProfileLineQuerySource; } export interface ElevationProfileLineQuerySource { queryElevation: QueryElevation; } export type QueryElevation = ( geometry: Point | Multipoint | Polyline, options?: QueryElevationOptions, ) => Promise; export interface QueryElevationOptions { demResolution?: number | string; returnSampleInfo?: boolean; noDataValue?: number; signal?: AbortSignal | nullish; } export class ElevationProfileLineView extends ElevationProfileLine { /** * Items which are to be excluded when querying elevation from view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html#exclude Read more...} */ exclude: IntersectItem | Iterable | Iterable> | nullish; /** * Items which are to be hit when querying elevation from view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html#include Read more...} */ include: IntersectItem | Iterable | Iterable> | nullish; /** * The line type. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html#type Read more...} */ readonly type: "view"; /** * Profile line which samples elevation directly from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html Read more...} */ constructor(properties?: ElevationProfileLineViewProperties); } interface ElevationProfileLineViewProperties extends ElevationProfileLineProperties { /** * Items which are to be excluded when querying elevation from view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html#exclude Read more...} */ exclude?: IntersectItem | Iterable | Iterable> | nullish; /** * Items which are to be hit when querying elevation from view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileLineView.html#include Read more...} */ include?: IntersectItem | Iterable | Iterable> | nullish; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#effectiveUnits Read more...} */ readonly effectiveUnits: EffectiveUnits; /** * Whether the graphic used as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#input input} * is highlighted. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled Read more...} */ highlightEnabled: boolean; /** * The position, in the range [0, 1], being hovered in the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition Read more...} */ hoveredChartPosition: number | nullish; /** * The progress, between 0 and 1 of generating all the configured elevation * profiles. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#progress Read more...} */ readonly progress: number; /** * The current state of the view model that can be used for rendering the UI * of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "creating" | "created" | "selecting" | "selected"; /** * Whether the chart should use a uniform scale for the X and Y axes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling Read more...} */ uniformChartScaling: boolean; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#unit Read more...} */ unit: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#unitOptions Read more...} */ unitOptions: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#view Read more...} */ view: SceneView | MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-elevation-profile/ Elevation Profile} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html ElevationProfile} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html Read more...} */ constructor(properties?: ElevationProfileViewModelProperties); /** * The input path along which elevation will be queried in order to generate an elevation profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#input Read more...} */ get input(): Graphic | nullish; set input(value: GraphicProperties | nullish); /** * Collection of elevation profile lines which are to be generated and displayed in the widget's * chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#profiles Read more...} */ get profiles(): Collection< ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView >; set profiles(value: CollectionProperties< | (ElevationProfileLineGroundProperties & { type: "ground" }) | (ElevationProfileLineInputProperties & { type: "input" }) | (ElevationProfileLineQueryProperties & { type: "query" }) | (ElevationProfileLineViewProperties & { type: "view" }) >); /** * Stops a creation/selection operation and restores the previously configured * input path. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#cancel Read more...} */ cancel(): void; /** * Clears the existing profile and stops any interaction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#clear Read more...} */ clear(): void; /** * If mode is "sketch" (the default), switches to the "creating" state in * which the user can draw a new line. * * @param options Start options. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#start Read more...} */ start(options?: ElevationProfileViewModelStartOptions): void; /** * Stops a creation/selection operation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#stop Read more...} */ stop(): void; } interface ElevationProfileViewModelProperties { /** * Whether the graphic used as {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#input input} * is highlighted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled Read more...} */ highlightEnabled?: boolean; /** * The position, in the range [0, 1], being hovered in the graph. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition Read more...} */ hoveredChartPosition?: number | nullish; /** * The input path along which elevation will be queried in order to generate an elevation profile. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#input Read more...} */ input?: GraphicProperties | nullish; /** * Collection of elevation profile lines which are to be generated and displayed in the widget's * chart. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#profiles Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling Read more...} */ uniformChartScaling?: boolean; /** * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#unit Read more...} */ unit?: SystemOrLengthUnit; /** * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#unitOptions Read more...} */ unitOptions?: SystemOrLengthUnit[]; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#view Read more...} */ view?: SceneView | MapView | nullish; } /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile-ElevationProfileViewModel.html#EffectiveUnits Read more...} */ export interface EffectiveUnits { distance: LengthUnit; elevation: LengthUnit; } export interface ElevationProfileViewModelStartOptions { mode?: "sketch" | "select"; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#VisibleElements Read more...} */ export interface ElevationProfileVisibleElementsProperties { legend?: boolean; chart?: boolean; clearButton?: boolean; settingsButton?: boolean; sketchButton?: boolean; selectButton?: boolean; unitSelector?: boolean; uniformChartScalingToggle?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ElevationProfile.html#VisibleElements Read more...} */ export interface ElevationProfileVisibleElements extends AnonymousAccessor { legend: boolean; chart: boolean; clearButton: boolean; settingsButton: boolean; sketchButton: boolean; selectButton: boolean; unitSelector: boolean; uniformChartScalingToggle: boolean; } export class Expand extends Widget { /** * Automatically collapses the expand widget instance when the view's * viewpoint updates. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#autoCollapse Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#closeOnEsc Read more...} */ closeOnEsc: boolean | Function; /** * Calcite icon used to style the Expand button when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#content content} can be collapsed. * * @default "chevrons-right" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#collapseIcon Read more...} */ collapseIcon: string; /** * Tooltip to display to indicate Expand widget can be collapsed. * * @default "Collapse" (English locale) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#collapseTooltip Read more...} */ collapseTooltip: string; /** * The content to display within the expanded Expand widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#content Read more...} */ content: string | HTMLElement | Widget | DomNodeOwner; /** * Indicates whether the widget is currently expanded or not. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expanded Read more...} */ expanded: boolean; /** * Calcite icon used when the widget is collapsed. * * @default "chevrons-left" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expandIcon Read more...} */ expandIcon: string | nullish; /** * Tooltip to display to indicate Expand widget can be expanded. * * @default "Expand" (English locale) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expandTooltip Read more...} */ expandTooltip: string; /** * Disables focus trapping within the expand widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#focusTrapDisabled Read more...} */ focusTrapDisabled: 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#group Read more...} */ group: string | nullish; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#iconNumber Read more...} */ iconNumber: number; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#label Read more...} */ label: string; /** * The mode in which the widget displays. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#mode Read more...} */ mode: "auto" | "floating" | "drawer"; /** * The placement used by the [calcite popover](https://doc.geoscene.cn/calcite-design-system/components/popover/) when the widget is expanded. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#placement Read more...} */ placement: | "auto" | "auto-start" | "auto-end" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end" | "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start" | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Expand widget acts as a clickable button for displaying interactive content, most commonly other widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html Read more...} */ constructor(properties?: ExpandProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#viewModel Read more...} */ get viewModel(): ExpandViewModel; set viewModel(value: ExpandViewModelProperties); /** * Collapse the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#collapse Read more...} */ collapse(): void; /** * Expand the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expand Read more...} */ expand(): void; /** * Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#toggle Read more...} */ toggle(): void; } interface ExpandProperties extends WidgetProperties { /** * Automatically collapses the expand widget instance when the view's * viewpoint updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#autoCollapse Read more...} */ autoCollapse?: boolean; /** * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#closeOnEsc Read more...} */ closeOnEsc?: boolean | Function; /** * Calcite icon used to style the Expand button when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#content content} can be collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#collapseIcon Read more...} */ collapseIcon?: string; /** * Tooltip to display to indicate Expand widget can be collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#collapseTooltip Read more...} */ collapseTooltip?: string; /** * The content to display within the expanded Expand widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#content Read more...} */ content?: string | HTMLElement | Widget | DomNodeOwner; /** * Indicates whether the widget is currently expanded or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expanded Read more...} */ expanded?: boolean; /** * Calcite icon used when the widget is collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expandIcon Read more...} */ expandIcon?: string | nullish; /** * Tooltip to display to indicate Expand widget can be expanded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#expandTooltip Read more...} */ expandTooltip?: string; /** * Disables focus trapping within the expand widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#focusTrapDisabled Read more...} */ focusTrapDisabled?: 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#group Read more...} */ group?: string | nullish; /** * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#iconNumber Read more...} */ iconNumber?: number; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#label Read more...} */ label?: string; /** * The mode in which the widget displays. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#mode Read more...} */ mode?: "auto" | "floating" | "drawer"; /** * The placement used by the [calcite popover](https://doc.geoscene.cn/calcite-design-system/components/popover/) when the widget is expanded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#placement Read more...} */ placement?: | "auto" | "auto-start" | "auto-end" | "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end" | "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start" | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#viewModel Read more...} */ viewModel?: ExpandViewModelProperties; } export class ExpandViewModel extends Accessor { /** * Automatically collapses the Expand instance when the view's * viewpoint updates. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#autoCollapse Read more...} */ autoCollapse: boolean; /** * Whether the element is currently expanded or not. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#expanded Read more...} */ expanded: boolean; /** * This value associates two or more Expand instances with each other, allowing one * instance to auto collapse when another instance in the same group is expanded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#group Read more...} */ group: string | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * The view in which the Expand is used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html Expand} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-expand/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html Read more...} */ constructor(properties?: ExpandViewModelProperties); } interface ExpandViewModelProperties { /** * Automatically collapses the Expand instance when the view's * viewpoint updates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#autoCollapse Read more...} */ autoCollapse?: boolean; /** * Whether the element is currently expanded or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#expanded Read more...} */ expanded?: boolean; /** * This value associates two or more Expand instances with each other, allowing one * instance to auto collapse when another instance in the same group is expanded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#group Read more...} */ group?: string | nullish; /** * The view in which the Expand is used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand-ExpandViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * A dom node owner. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Expand.html#DomNodeOwner Read more...} */ export interface DomNodeOwner { domNode: HTMLElement; } export class Feature extends Widget { /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled: boolean; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#title title} of the feature widget. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "polygon" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#label Read more...} */ label: string; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#graphic graphic} has a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#map Read more...} */ map: Map | nullish; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#timeZone Read more...} */ timeZone: string; /** * The title for the feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#title Read more...} */ readonly title: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The visible elements that are displayed within the widget's [graphic.popupTemplate.content](geoscene-PopupTemplate.html#content). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#visibleElements Read more...} */ visibleElements: FeatureVisibleElements; /** * The Feature widget displays a graphic according to its [PopupTemplate](geoscene-PopupTemplate.html). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Read more...} */ constructor(properties?: FeatureProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} used to represent the feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#graphic Read more...} */ get graphic(): Graphic | nullish; set graphic(value: GraphicProperties | nullish); /** * The location of the graphic to be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#viewModel Read more...} */ get viewModel(): FeatureViewModel; set viewModel(value: FeatureViewModelProperties); /** * Paginates to the next [media](geoscene-popup-content-MediaContent.html) info. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#nextMedia Read more...} */ nextMedia(contentElementIndex: number): void; /** * Paginates to the previous [media](geoscene-popup-content-MediaContent.html) info in the specified * [media](geoscene-popup-content-MediaContent.html) content element. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#previousMedia Read more...} */ previousMedia(contentElementIndex: number): void; /** * Paginates to a specified [media](geoscene-popup-content-MediaContent.html) info object. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element to be updated. * @param mediaInfoIndex The index position of the [media](geoscene-popup-content-MediaContent.html) info object you wish to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#setActiveMedia Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} used to represent the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#graphic Read more...} */ graphic?: GraphicProperties | nullish; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#title title} of the feature widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#label Read more...} */ label?: string; /** * The location of the graphic to be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#location Read more...} */ location?: PointProperties | nullish; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#graphic graphic} has a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#map Read more...} */ map?: Map | nullish; /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#timeZone Read more...} */ timeZone?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#viewModel Read more...} */ viewModel?: FeatureViewModelProperties; /** * The visible elements that are displayed within the widget's [graphic.popupTemplate.content](geoscene-PopupTemplate.html#content). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html#visibleElements Read more...} */ visibleElements?: FeatureVisibleElements; } export class FeatureViewModel extends Accessor { /** * Defines the specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#Abilities abilities} that the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} widgets should use when querying and displaying its content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#abilities Read more...} */ abilities: Abilities; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html#content content} of the feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#content Read more...} */ readonly content: Content[] | Widget | HTMLElement | string | nullish; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled: boolean; /** * The formatted attributes calculated from `fieldInfo` {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} * content. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#formattedAttributes Read more...} */ readonly formattedAttributes: FeatureViewModelFormattedAttributes | nullish; /** * Indicates whether the current FeatureViewModel's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic graphic} resides in a non-spatial table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#isFeatureFromTable Read more...} */ readonly isFeatureFromTable: boolean; /** * A read-only property containing metadata regarding the last edit performed on a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#lastEditInfo Read more...} */ readonly lastEditInfo: FeatureViewModelLastEditInfo | nullish; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic graphic} has a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#map Read more...} */ map: Map | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "error" | "loading"; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#timeZone Read more...} */ timeZone: string; /** * The title for the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#title Read more...} */ readonly title: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Indicates whether the feature is currently waiting for all of its content to finish loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#waitingForContent Read more...} */ readonly waitingForContent: boolean; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-feature/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html Read more...} */ constructor(properties?: FeatureViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} used to represent the feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic Read more...} */ get graphic(): Graphic | nullish; set graphic(value: GraphicProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} interaction used to trigger the opening of the widget. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * Paginates to the next [media](geoscene-popup-content-MediaContent.html) info. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#nextMedia Read more...} */ nextMedia(contentElementIndex: number): void; /** * Paginates to the previous [media](geoscene-popup-content-MediaContent.html) info in the specified * [media](geoscene-popup-content-MediaContent.html) content element. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#previousMedia Read more...} */ previousMedia(contentElementIndex: number): void; /** * Paginates to a specified [media](geoscene-popup-content-MediaContent.html) info object. * * @param contentElementIndex The index position of the [media](geoscene-popup-content-MediaContent.html) content element to be updated. * @param mediaInfoIndex The index position of the [media](geoscene-popup-content-MediaContent.html) info object you wish to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#setActiveMedia Read more...} */ setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void; /** * Fetches the geometry of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic graphic} if the geometry does not exist. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#updateGeometry Read more...} */ updateGeometry(): void; } interface FeatureViewModelProperties { /** * Defines the specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#Abilities abilities} that the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} widgets should use when querying and displaying its content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#abilities Read more...} */ abilities?: Abilities; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} used to represent the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic Read more...} */ graphic?: GraphicProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} interaction used to trigger the opening of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#location Read more...} */ location?: PointProperties | nullish; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#graphic graphic} has a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#map Read more...} */ map?: Map | nullish; /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#timeZone Read more...} */ timeZone?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * This object defines specific abilities for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#Abilities Read more...} */ export interface Abilities { attachmentsContent?: boolean; chartAnimation?: boolean; customContent?: boolean; fieldsContent?: boolean; mediaContent?: boolean; relationshipContent?: boolean; textContent?: boolean; utilityNetworkAssociationsContent?: boolean; } export interface FeatureViewModelFormattedAttributes { global?: any; content?: any; } export interface FeatureViewModelLastEditInfo { user: string; date: string; type: "edit" | "create"; } export interface VisibleContentElements { attachments?: boolean; fields?: boolean; media?: boolean; text?: boolean; expression?: boolean; relationship?: boolean; } export interface FeatureVisibleElements { title?: boolean; content?: boolean | VisibleContentElements; lastEditedInfo?: boolean; } export class FeatureForm extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#disabled Read more...} */ disabled: boolean; /** * The associated feature containing the editable attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#feature Read more...} */ feature: Graphic | nullish; /** * Defines how groups will be displayed to the user. * * @default "all" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#groupDisplay Read more...} */ groupDisplay: "all" | "sequential"; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#title title} of the form. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#headingLevel Read more...} */ headingLevel: number; /** * Icon displayed in the widget's button. * * @default "form-field" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#label Read more...} */ label: string; /** * Layer containing the editable feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#layer Read more...} */ layer: | FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | KnowledgeGraphSublayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#map Read more...} */ map: Map | nullish; /** * The timezone displayed within the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#timeZone Read more...} */ timeZone: string | nullish; /** * Defines which elements are visible in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#visibleElements Read more...} */ visibleElements: FeatureFormVisibleElements; /** * The FeatureForm widget displays attributes of a feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html Read more...} */ constructor(properties?: FeatureFormProperties); /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used for the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#formTemplate Read more...} */ get formTemplate(): FormTemplate | nullish; set formTemplate(value: FormTemplateProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#viewModel Read more...} */ get viewModel(): FeatureFormViewModel; set viewModel(value: FeatureFormViewModelProperties); /** * Returns all of the field values, regardless of update status. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#getValues Read more...} */ getValues(): any; /** * Fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#event-submit submit} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#submit Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#disabled Read more...} */ disabled?: boolean; /** * The associated feature containing the editable attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#feature Read more...} */ feature?: Graphic | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used for the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#formTemplate Read more...} */ formTemplate?: FormTemplateProperties | nullish; /** * Defines how groups will be displayed to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#groupDisplay Read more...} */ groupDisplay?: "all" | "sequential"; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#title title} of the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#label Read more...} */ label?: string; /** * Layer containing the editable feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#layer Read more...} */ layer?: | FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | KnowledgeGraphSublayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#map Read more...} */ map?: Map | nullish; /** * The timezone displayed within the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#timeZone Read more...} */ timeZone?: string | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#viewModel Read more...} */ viewModel?: FeatureFormViewModelProperties; /** * Defines which elements are visible in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#visibleElements Read more...} */ visibleElements?: FeatureFormVisibleElements; } export class FeatureFormEditableInput { } export interface FeatureFormViewModel extends Accessor, Evented { } export class FeatureFormViewModel { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html UtilityNetworkAssociationInput} providing * association data for the active workflow and selected association type in the Editor widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#activeAssociationInput Read more...} */ readonly activeAssociationInput: UtilityNetworkAssociationInput | nullish; /** * The edit type for the form, which determines the editing context and behavior. * * @default "NA" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#editType Read more...} */ editType: "INSERT" | "UPDATE" | "DELETE" | "NA"; /** * The associated feature containing the editable attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#feature Read more...} */ feature: Graphic | nullish; /** * The field, group, or relationship inputs that make up the form * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#inputs Read more...} */ readonly inputs: ( | FeatureFormFieldInput | FeatureFormGroupInput | RelationshipInput | TextElementInput | UtilityNetworkAssociationInput )[]; /** * Layer containing the editable feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#layer Read more...} */ layer: | FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | KnowledgeGraphSublayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#map Read more...} */ map: Map | nullish; /** * The widget's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#submittable Read more...} */ submittable: boolean; /** * The timezone displayed within the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#timeZone Read more...} */ timeZone: string; /** * Indicates whether the form is currently updating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#updating Read more...} */ readonly updating: boolean; /** * Indicates whether all of the input fields are valid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#valid Read more...} */ readonly valid: boolean; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html FeatureForm} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html Read more...} */ constructor(properties?: FeatureFormViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} that the selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#feature feature} is involved in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#activeAssociation Read more...} */ get activeAssociation(): Association | nullish; set activeAssociation(value: AssociationProperties | nullish); /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used for the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate Read more...} */ get formTemplate(): FormTemplate | nullish; set formTemplate(value: FormTemplateProperties | nullish); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Convenience method to find field inputs. * * @param fieldName The input field to find. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#findField Read more...} */ findField(fieldName: string | nullish): FeatureFormFieldInput | nullish; /** * Returns all of the field values, regardless of whether or not they were updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#getValues Read more...} */ getValues(): any; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * The method used to set the updated field value. * * @param fieldName The target field to update. * @param value The value to set on the target field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#setValue Read more...} */ setValue(fieldName: string, value: number | string | nullish): void; /** * Fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#event-submit submit} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#submit Read more...} */ submit(): void; /** * Validates whether a feature's attribute values conform to the defined contingent values. * * @param values A hash map of the form fields and their values. * @param options An object specifying additional options on what should be considered an error. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#validateContingencyConstraints Read more...} */ validateContingencyConstraints(values: HashMap, options?: FeatureFormViewModelValidateContingencyConstraintsOptions): any[]; on(name: "value-change", eventHandler: FeatureFormViewModelValueChangeEventHandler): IHandle; on(name: "submit", eventHandler: FeatureFormViewModelSubmitEventHandler): IHandle; } interface FeatureFormViewModelProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-Association.html Association} that the selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#feature feature} is involved in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#activeAssociation Read more...} */ activeAssociation?: AssociationProperties | nullish; /** * The edit type for the form, which determines the editing context and behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#editType Read more...} */ editType?: "INSERT" | "UPDATE" | "DELETE" | "NA"; /** * The associated feature containing the editable attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#feature Read more...} */ feature?: Graphic | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-form-FormTemplate.html template} used for the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate Read more...} */ formTemplate?: FormTemplateProperties | nullish; /** * Layer containing the editable feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#layer Read more...} */ layer?: | FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | KnowledgeGraphSublayer | nullish; /** * A reference to the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#map Read more...} */ map?: Map | nullish; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#submittable Read more...} */ submittable?: boolean; /** * The timezone displayed within the form. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FeatureFormViewModel.html#timeZone Read more...} */ timeZone?: string; } export interface FeatureFormViewModelValidateContingencyConstraintsOptions { 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 | nullish; } export interface FeatureFormFieldInput extends Accessor, FeatureFormEditableInput, FeatureFormInputBase { } export class FeatureFormFieldInput { /** * The type of data displayed by the field input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#dataType Read more...} */ readonly dataType: "number" | "text" | "date" | "unsupported"; /** * The input value's domain. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#domain Read more...} */ readonly domain: CodedValueDomain | RangeDomain | InheritedDomain | nullish; /** * Indicates if the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#editable Read more...} */ readonly editable: boolean; /** * If the input field's value is invalid, this property returns a validation error code. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#error Read more...} */ readonly error: string | nullish; /** * The associated field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#field Read more...} */ readonly field: Field; /** * The group containing the field input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#group Read more...} */ readonly group: FeatureFormGroupInput | nullish; /** * A hint for the field's value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#hint Read more...} */ readonly hint: string | nullish; /** * Indicates whether date information is included for date inputs. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#includeDate Read more...} */ readonly includeDate: boolean; /** * Indicates whether time information is included for date inputs. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#includeTime Read more...} */ readonly includeTime: boolean; /** * Indicates whether timestamp information is included for date inputs. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#includeTimeOffset Read more...} */ readonly includeTimeOffset: boolean; /** * The type of editor used when working with `string` fields. * * @default "text-box" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#inputType Read more...} */ readonly inputType: | "switch" | "barcode-scanner" | "combo-box" | "date-picker" | "datetime-picker" | "datetimeoffset-picker" | "radio-buttons" | "text-area" | "text-box" | "time-picker" | nullish; /** * The field's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#label Read more...} */ readonly label: string; /** * Restricts the input length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#maxLength Read more...} */ readonly maxLength: number; /** * Restricts the input length. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#minLength Read more...} */ readonly minLength: number; /** * The associated field name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#name Read more...} */ readonly name: string; /** * Indicates whether the field is required. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#required Read more...} */ required: boolean; /** * Indicates if the field's value can be submitted without introducing data validation issues. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#submittable Read more...} */ readonly submittable: boolean; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#type Read more...} */ readonly type: "field"; /** * Indicates if the field is updating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#updating Read more...} */ readonly updating: boolean; /** * Indicates if the input value is valid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#valid Read more...} */ readonly valid: boolean; /** * The field input's value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#value Read more...} */ readonly value: number | string | nullish; /** * Indicates if the field is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#visible Read more...} */ readonly visible: boolean; /** * This is a read-only support class that represents a field's input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html Read more...} */ constructor(properties?: FeatureFormFieldInputProperties); } interface FeatureFormFieldInputProperties { /** * Indicates whether the field is required. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-FieldInput.html#required Read more...} */ required?: boolean; } export interface FeatureFormGroupInput extends Accessor, FeatureFormInputBase { } export class FeatureFormGroupInput { /** * Defines if the group should be expanded or collapsed when the form is initially displayed. * * @default "expanded" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#initialState Read more...} */ readonly initialState: "expanded" | "collapsed"; /** * The field inputs contained within the group. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#inputs Read more...} */ readonly inputs: (FeatureFormFieldInput | RelationshipInput | TextElementInput | UtilityNetworkAssociationInput)[]; /** * The group's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#label Read more...} */ readonly label: string | nullish; /** * Indicates whether or not the group is open, ie. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#open Read more...} */ open: boolean; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#type Read more...} */ readonly type: "group"; /** * The group's visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#visible Read more...} */ readonly visible: boolean; /** * This is a support class that represents a group of field inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html Read more...} */ constructor(properties?: FeatureFormGroupInputProperties); } interface FeatureFormGroupInputProperties { /** * Indicates whether or not the group is open, ie. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-GroupInput.html#open Read more...} */ open?: boolean; } export class FeatureFormInputBase { } export interface RelationshipInput extends Accessor, FeatureFormEditableInput, FeatureFormInputBase { } export class RelationshipInput { /** * A numeric value indicating the maximum number of related features to display in the list of related records. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#displayCount Read more...} */ readonly displayCount: number; /** * A string value indicating how to display related records within the relationship content. * * @default "list" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#displayType Read more...} */ readonly displayType: "list"; /** * Indicates whether the input is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#editable Read more...} */ readonly editable: boolean; /** * The group containing the relationship input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#group Read more...} */ readonly group: FeatureFormGroupInput | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-support-RelatedRecordsInfoFieldOrder.html RelatedRecordsInfoFieldOrder} * objects indicating the field display order for the related records * and whether they should be sorted in ascending `asc` or descending `desc` order. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#orderByFields Read more...} */ readonly orderByFields: RelatedRecordsInfoFieldOrder[] | nullish; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#type Read more...} */ readonly type: "relationship"; /** * Indicates whether the form is currently updating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html#updating Read more...} */ readonly updating: boolean; /** * This is a read-only support class that represents a relationship input field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-RelationshipInput.html Read more...} */ constructor(properties?: RelationshipInputProperties); } interface RelationshipInputProperties { } export interface TextElementInput extends Accessor, FeatureFormInputBase { } export class TextElementInput { /** * All Aracde expressions referenced, via string substitution, in the text * content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#expressionsUsed Read more...} */ readonly expressionsUsed: string[]; /** * The names of all fields referenced, via string templates, in the text * content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#fieldsUsed Read more...} */ readonly fieldsUsed: string[]; /** * The group containing the text element input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#group Read more...} */ readonly group: FeatureFormGroupInput | nullish; /** * The content of the TextElement, as a string in either plain-text (no * formatting) or Markdown. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#rawText Read more...} */ rawText: string | nullish; /** * The processed text, compiled and with template parameters replaced with * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#text Read more...} */ text: string; /** * Defines the format of the `text` property. * * @default "plain-text" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#textFormat Read more...} */ textFormat: "plain-text" | "markdown"; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#type Read more...} */ readonly type: "text"; constructor(properties?: TextElementInputProperties); } interface TextElementInputProperties { /** * The content of the TextElement, as a string in either plain-text (no * formatting) or Markdown. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#rawText Read more...} */ rawText?: string | nullish; /** * The processed text, compiled and with template parameters replaced with * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#text Read more...} */ text?: string; /** * Defines the format of the `text` property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-TextElementInput.html#textFormat Read more...} */ textFormat?: "plain-text" | "markdown"; } export interface UtilityNetworkAssociationInput extends Accessor, FeatureFormEditableInput, FeatureFormInputBase { } export class UtilityNetworkAssociationInput { /** * Indicates whether the input is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html#editable Read more...} */ readonly editable: boolean; /** * The group containing the relationship input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html#group Read more...} */ readonly group: FeatureFormGroupInput | nullish; /** * The type of input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html#type Read more...} */ readonly type: "utilityNetworkAssociations"; /** * Indicates whether the form is currently updating. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html#updating Read more...} */ readonly updating: boolean; constructor(properties?: UtilityNetworkAssociationInputProperties); /** * Refreshes the associations view model for this Input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm-UtilityNetworkAssociationInput.html#refresh Read more...} */ refresh(): Promise; } interface UtilityNetworkAssociationInputProperties { } export interface FeatureFormSubmitEvent { invalid: string[]; valid: string[]; values: any; } export interface FeatureFormValueChangeEvent { feature: Graphic; fieldName: string; layer: FeatureLayer; valid: boolean; value: number | string | nullish; } /** * An object containing properties that control the visibility of certain elements within the FeatureForm widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureForm.html#VisibleElements Read more...} */ export interface FeatureFormVisibleElements { readOnlyNotice?: boolean; } export interface Features extends Widget, GoTo, Evented { } export class Features { /** * Indicates if the widget is active when it is visible and is not {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#waitingForResult waiting for results}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#active Read more...} */ readonly active: boolean; /** * Indicates whether the popup displays its content. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#collapsed Read more...} */ collapsed: boolean; /** * The content of the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#content Read more...} */ content: string | HTMLElement | Widget | nullish; /** * Indicates whether the feature navigation arrows are displayed at the top of the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#featureNavigationTop Read more...} */ featureNavigationTop: boolean; /** * An array of features associated with the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#features Read more...} */ features: Graphic[]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#title title} of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#headingLevel Read more...} */ headingLevel: number; /** * Indicates whether to initially display a list of features, or the content for one feature. * * @default "feature" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#initialDisplayMode Read more...} */ initialDisplayMode: "list" | "feature"; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#label Read more...} */ label: string; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#features features} have a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#map Read more...} */ map: Map | nullish; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#promises Read more...} */ promises: Promise[]; /** * The feature that the widget has drilled into. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedDrillInFeature Read more...} */ readonly selectedDrillInFeature: Graphic | nullish; /** * The selected feature accessed by the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeature Read more...} */ readonly selectedFeature: Graphic | nullish; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex: number; /** * Returns a reference to the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeatureWidget Read more...} */ readonly selectedFeatureWidget: Feature | nullish; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#timeZone Read more...} */ timeZone: string; /** * The title of the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#title Read more...} */ title: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#view Read more...} */ view: MapView | SceneView | nullish; /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html Read more...} */ constructor(properties?: FeaturesProperties); /** * The actions that are displayed in the header of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#headerActions Read more...} */ get headerActions(): Collection; set headerActions(value: CollectionProperties); /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * This is a class that contains all the logic * (properties and methods) that controls this widget's behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#viewModel Read more...} */ get viewModel(): FeaturesViewModel; set viewModel(value: FeaturesViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#visibleElements Read more...} */ get visibleElements(): FeaturesVisibleElements; set visibleElements(value: FeaturesVisibleElementsProperties); /** * Use this method to remove focus from the Widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#blur Read more...} */ blur(): void; /** * Removes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#promises promises}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#features features}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#content content}, and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#title title} from the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#clear Read more...} */ clear(): void; /** * This is a convenience method to closes the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#close Read more...} */ close(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Use this method to return feature(s) at a given screen location. * * @param screenPoint An object representing a point on the screen. This point can be in either the MapView or SceneView. * @param options The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#FetchFeaturesOptions options} to pass into the `fetchFeatures` method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#fetchFeatures Read more...} */ fetchFeatures(screenPoint: FeaturesFetchFeaturesScreenPoint, options?: FetchFeaturesOptions): Promise; /** * Use this method to give focus to the Widget if the widget is able to be focused. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#focus Read more...} */ focus(): void; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Selects the feature at the next index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#next Read more...} */ next(): FeaturesViewModel; /** * Opens the Features widget in its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#container container} with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the content of the Feature's widget when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#open Read more...} */ open(options?: FeaturesOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#previous Read more...} */ previous(): FeaturesViewModel; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#event-trigger-action trigger-action} event and executes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions action} * at the specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions actions} array. * * @param actionIndex The index of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#actions action} to execute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#triggerAction Read more...} */ triggerAction(actionIndex: number): void; on(name: "trigger-action", eventHandler: FeaturesTriggerActionEventHandler): IHandle; } interface FeaturesProperties extends WidgetProperties, GoToProperties { /** * Indicates whether the popup displays its content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#collapsed Read more...} */ collapsed?: boolean; /** * The content of the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#content Read more...} */ content?: string | HTMLElement | Widget | nullish; /** * Indicates whether the feature navigation arrows are displayed at the top of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#featureNavigationTop Read more...} */ featureNavigationTop?: boolean; /** * An array of features associated with the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#features Read more...} */ features?: Graphic[]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The actions that are displayed in the header of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#headerActions Read more...} */ headerActions?: CollectionProperties; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#title title} of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#headingLevel Read more...} */ headingLevel?: number; /** * Indicates whether to initially display a list of features, or the content for one feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#initialDisplayMode Read more...} */ initialDisplayMode?: "list" | "feature"; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#label Read more...} */ label?: string; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#features features} have a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#map Read more...} */ map?: Map | nullish; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#promises Read more...} */ promises?: Promise[]; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex?: number; /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#timeZone Read more...} */ timeZone?: string; /** * The title of the Features widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#title Read more...} */ title?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * This is a class that contains all the logic * (properties and methods) that controls this widget's behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#viewModel Read more...} */ viewModel?: FeaturesViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#visibleElements Read more...} */ visibleElements?: FeaturesVisibleElementsProperties; } export interface FeaturesViewModel extends Accessor, Evented, GoTo { } export class FeaturesViewModel { /** * Indicates if the view model is active when it is visible and is not {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#waitingForResult waiting for results}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#active Read more...} */ readonly active: boolean; /** * The highlighted feature on the map that is either hovered over or in focus within the feature menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#activeFeature Read more...} */ activeFeature: Graphic | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html actions} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggles}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#allActions Read more...} */ readonly allActions: Collection; /** * This closes the container when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} camera or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} changes. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#autoCloseEnabled Read more...} */ autoCloseEnabled: boolean; /** * Indicates if the "Browse features" experience is active in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html cluster} popup. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#browseClusterEnabled Read more...} */ browseClusterEnabled: boolean; /** * The information to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#content Read more...} */ content: string | HTMLElement | Widget | nullish; /** * A read-only property that specifies a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of action {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html buttons} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html toggles}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#defaultActions Read more...} */ readonly defaultActions: Collection; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled: boolean; /** * The number of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features features} available. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureCount Read more...} */ readonly featureCount: number; /** * This property enables showing the list of features. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureMenuOpen Read more...} */ featureMenuOpen: boolean; /** * The title to display on the widget while viewing the feature menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureMenuTitle Read more...} */ featureMenuTitle: string | nullish; /** * The current page number in the feature browsing menu. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featurePage Read more...} */ featurePage: number | nullish; /** * An array of features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features Read more...} */ features: Graphic[]; /** * The number of features to fetch at one time. * * @default 20 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featuresPerPage Read more...} */ featuresPerPage: number; /** * Defines the specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#Abilities abilities} that can be used when querying and displaying content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities Read more...} */ featureViewModelAbilities: Abilities | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html feature view model(s)}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureViewModels Read more...} */ readonly featureViewModels: FeatureViewModel[]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Highlight the selected feature using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#highlightOptions highlightOptions} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlightOptions highlightOptions} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#highlightEnabled Read more...} */ highlightEnabled: boolean; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#defaultActions defaultActions}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#includeDefaultActions Read more...} */ includeDefaultActions: boolean; /** * Indicates whether to initially display a list of features, or the content for one feature. * * @default "feature" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#initialDisplayMode Read more...} */ initialDisplayMode: "list" | "feature"; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features features} have a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#map Read more...} */ map: Map | nullish; /** * The number of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises promises} remaining to be resolved. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#pendingPromisesCount Read more...} */ readonly pendingPromisesCount: number; /** * The number of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises promises} available. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promiseCount Read more...} */ readonly promiseCount: number; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises Read more...} */ promises: Promise[]; /** * The screen location of the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#screenLocation Read more...} */ screenLocation: FeaturesViewModelScreenPoint | nullish; /** * Determines whether screen point tracking is active for positioning. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#screenLocationEnabled Read more...} */ screenLocationEnabled: boolean; /** * The graphic used to represent the cluster extent when the `Browse features` action * is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedClusterBoundaryFeature Read more...} */ readonly selectedClusterBoundaryFeature: Graphic; /** * The selected feature accessed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeature Read more...} */ readonly selectedFeature: Graphic | nullish; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html view model} of the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeatureViewModel Read more...} */ readonly selectedFeatureViewModel: FeatureViewModel; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * Dates and times will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#timeZone Read more...} */ timeZone: string; /** * The title of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#title Read more...} */ title: string | nullish; /** * Indicates whether to update the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#location location} when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex selectedFeatureIndex} changes. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#updateLocationEnabled Read more...} */ updateLocationEnabled: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Indicates whether the widget is visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#visible Read more...} */ visible: boolean; /** * Indicates whether the widget is waiting for content to be resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#waitingForContents Read more...} */ readonly waitingForContents: boolean; /** * Indicates whether a feature was found while resolving {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises promises}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#waitingForResult Read more...} */ readonly waitingForResult: boolean; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html Features} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-features/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html Read more...} */ constructor(properties?: FeaturesViewModelProperties); /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions Read more...} */ get actions(): Collection; set actions(value: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >); /** * Geometry used to show the location of the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#spatialReference Read more...} */ get spatialReference(): SpatialReference | nullish; set spatialReference(value: SpatialReferenceProperties | nullish); /** * Removes all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises promises}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features features}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#content content}, and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#title title}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#clear Read more...} */ clear(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Use this method to return feature(s) at a given screen location. * * @param screenPoint An object representing a point on the screen. This point can be in either the MapView or SceneView. * @param options The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#FetchFeaturesOptions options} to pass into the `fetchFeatures` method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#fetchFeatures Read more...} */ fetchFeatures(screenPoint: FeaturesViewModelFetchFeaturesScreenPoint | nullish, options?: PopupFetchFeaturesOptions): Promise; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Selects the feature at the next index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#next Read more...} */ next(): FeaturesViewModel; /** * Opens the widget at the given location with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the location and content of the popup when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#open Read more...} */ open(options?: FeaturesViewModelOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#previous Read more...} */ previous(): FeaturesViewModel; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#event-trigger-action trigger-action} event and executes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions action} * at the specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions actions} array. * * @param actionIndex The index of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions action} to execute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#triggerAction Read more...} */ triggerAction(actionIndex: number): void; /** * Sets the view to a given target. * * @param params The parameters to pass to the `zoomTo()` method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#zoomTo Read more...} */ zoomTo(params: GoToParameters): Promise; on(name: "trigger-action", eventHandler: FeaturesViewModelTriggerActionEventHandler): IHandle; } interface FeaturesViewModelProperties extends GoToProperties { /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#actions Read more...} */ actions?: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >; /** * The highlighted feature on the map that is either hovered over or in focus within the feature menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#activeFeature Read more...} */ activeFeature?: Graphic | nullish; /** * This closes the container when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} camera or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#autoCloseEnabled Read more...} */ autoCloseEnabled?: boolean; /** * Indicates if the "Browse features" experience is active in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureReductionCluster.html cluster} popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#browseClusterEnabled Read more...} */ browseClusterEnabled?: boolean; /** * The information to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#content Read more...} */ content?: string | HTMLElement | Widget | nullish; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled?: boolean; /** * This property enables showing the list of features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureMenuOpen Read more...} */ featureMenuOpen?: boolean; /** * The title to display on the widget while viewing the feature menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureMenuTitle Read more...} */ featureMenuTitle?: string | nullish; /** * The current page number in the feature browsing menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featurePage Read more...} */ featurePage?: number | nullish; /** * An array of features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features Read more...} */ features?: Graphic[]; /** * The number of features to fetch at one time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featuresPerPage Read more...} */ featuresPerPage?: number; /** * Defines the specific {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature-FeatureViewModel.html#Abilities abilities} that can be used when querying and displaying content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities Read more...} */ featureViewModelAbilities?: Abilities | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Highlight the selected feature using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#highlightOptions highlightOptions} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlightOptions highlightOptions} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#highlightEnabled Read more...} */ highlightEnabled?: boolean; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#defaultActions defaultActions}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#includeDefaultActions Read more...} */ includeDefaultActions?: boolean; /** * Indicates whether to initially display a list of features, or the content for one feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#initialDisplayMode Read more...} */ initialDisplayMode?: "list" | "feature"; /** * Geometry used to show the location of the feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#location Read more...} */ location?: PointProperties | nullish; /** * A map is required when the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#features features} have a popupTemplate that contains [Arcade](https://doc.geoscene.cn/arcade) expressions in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-ExpressionInfo.html ExpressionInfo} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-popup-content-ExpressionContent.html ExpressionContent} that may use the `$map` profile variable to access data from layers within a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#map Read more...} */ map?: Map | nullish; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#promises Read more...} */ promises?: Promise[]; /** * The screen location of the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#screenLocation Read more...} */ screenLocation?: FeaturesViewModelScreenPoint | nullish; /** * Determines whether screen point tracking is active for positioning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#screenLocationEnabled Read more...} */ screenLocationEnabled?: boolean; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex?: number; /** * The spatial reference used for [Arcade](https://doc.geoscene.cn/arcade) operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#spatialReference Read more...} */ spatialReference?: SpatialReferenceProperties | nullish; /** * Dates and times will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#timeZone Read more...} */ timeZone?: string; /** * The title of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#title Read more...} */ title?: string | nullish; /** * Indicates whether to update the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#location location} when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#selectedFeatureIndex selectedFeatureIndex} changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#updateLocationEnabled Read more...} */ updateLocationEnabled?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * Indicates whether the widget is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#visible Read more...} */ visible?: boolean; } export interface FeaturesViewModelFetchFeaturesScreenPoint { x: number; y: number; } export interface FeaturesViewModelOpenOptions { title?: string; content?: string; fetchFeatures?: boolean; location?: Point; features?: Graphic[]; promises?: Promise[]; updateLocationEnabled?: boolean; } /** * An object representing a point on the screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features-FeaturesViewModel.html#ScreenPoint Read more...} */ export interface FeaturesViewModelScreenPoint { x: number; y: number; } export interface FeaturesViewModelTriggerActionEvent { action: ActionButton | ActionToggle; } export interface FeaturesFetchFeaturesScreenPoint { x: number; y: number; } export interface FeaturesOpenOptions { actions?: Collection; collapsed?: boolean; content?: string | HTMLElement | Widget; features?: Graphic[]; featureMenuOpen?: boolean; featureMenuTitle?: string; fetchFeatures?: boolean; location?: Point; promises?: Promise[]; title?: string; updateLocationEnabled?: boolean; } /** * Optional properties to use with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#fetchFeatures fetchFeatures} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#FetchFeaturesOptions Read more...} */ export interface FetchFeaturesOptions { event?: any; signal?: AbortSignal | nullish; } export interface FeaturesTriggerActionEvent { action: ActionButton; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#VisibleElements Read more...} */ export interface FeaturesVisibleElementsProperties { actionBar?: boolean; closeButton?: boolean; collapseButton?: boolean; featureMenuHeading?: boolean; featureNavigation?: boolean; featureListLayerTitle?: boolean; flow?: boolean; heading?: boolean; spinner?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Features.html#VisibleElements Read more...} */ export interface FeaturesVisibleElements extends AnonymousAccessor { actionBar: boolean; closeButton: boolean; collapseButton: boolean; featureMenuHeading: boolean; featureNavigation: boolean; featureListLayerTitle: boolean; flow: boolean; heading: boolean; spinner: boolean; } export class FeatureTable extends Widget { /** * Reference to the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html action column}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#actionColumn Read more...} */ readonly actionColumn: ActionColumn | nullish; /** * Configuration for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html ActionColumn}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#actionColumnConfig Read more...} */ actionColumnConfig: ActionColumnConfig | nullish; /** * A read-only property indicating the type of filter used by the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#activeFilters Read more...} */ readonly activeFilters: Collection; /** * Use this read-only property if needing to query features while retaining a column's sort order. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#activeSortOrders Read more...} */ readonly activeSortOrders: ColumnSortOrder[]; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#allColumns Read more...} */ readonly allColumns: Column[]; /** * Indicates the table is displaying all related tables in `show all` mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#allRelatedTablesVisible Read more...} */ readonly allRelatedTablesVisible: boolean; /** * A flattened array of all visible {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#allVisibleColumns Read more...} */ readonly allVisibleColumns: Column[]; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html attachment columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attachmentsColumns Read more...} */ readonly attachmentsColumns: AttachmentsColumn[]; /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attachmentsEnabled Read more...} */ attachmentsEnabled: boolean; /** * This read-only property provides the the configuration options for the attachments view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attachmentsViewOptions Read more...} */ readonly attachmentsViewOptions: AttachmentsViewOptions; /** * Indicates whether the table should automatically refresh when the underlying data changes. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#autoRefreshEnabled Read more...} */ autoRefreshEnabled: boolean; /** * Indicates whether to enable the table's column performance mode. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#columnPerformanceModeEnabled Read more...} */ columnPerformanceModeEnabled: boolean; /** * Indicates whether the table should allow reordering of columns. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#columnReorderingEnabled Read more...} */ columnReorderingEnabled: boolean; /** * A read-only collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html column}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html group}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html action}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html attachment}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html relationship} columns that are displayed within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#columns Read more...} */ readonly columns: Collection< Column | FieldColumn | GroupColumn | ActionColumn | AttachmentsColumn | RelationshipColumn >; /** * The SQL where clause used to filter features visible in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * Text displayed in the table header, under the title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#description Read more...} */ description: string | Function | nullish; /** * Indicates whether the table is disabled. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#disabled Read more...} */ disabled: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#editing-in-featuretable editing} is enabled on the data within the feature table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#editingEnabled Read more...} */ editingEnabled: boolean; /** * The total number of records displayed in the table's current view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#effectiveSize Read more...} */ readonly effectiveSize: number; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html field columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#fieldColumns Read more...} */ readonly fieldColumns: FieldColumn[]; /** * Indicates whether the table only displays rows that are considered selected. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#filterBySelectionEnabled Read more...} */ filterBySelectionEnabled: boolean; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html group columns} within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#groupColumns Read more...} */ readonly groupColumns: GroupColumn[]; /** * Indicates whether to highlight the associated feature when a row is selected by checking the corresponding checkbox. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#highlightEnabled Read more...} */ highlightEnabled: boolean; /** * The string value which indicates the displayed [icon](https://doc.geoscene.cn/calcite-design-system/icons/). * * @default "table" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#icon Read more...} */ icon: string; /** * The user-provided number of total features accessed from the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#initialSize Read more...} */ initialSize: number | nullish; /** * Indicates if the table is querying or syncing data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#isQueryingOrSyncing Read more...} */ readonly isQueryingOrSyncing: boolean; /** * Indicates if the table is syncing attachment edits. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#isSyncingAttachments Read more...} */ readonly isSyncingAttachments: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#label Read more...} */ label: string; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layer Read more...} */ layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | Sublayer | nullish; /** * An array of layers listed within the [dropdown component](https://doc.geoscene.cn/calcite-design-system/components/dropdown/) of the table's header. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layers Read more...} */ layers: | ( | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer )[] | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html layer view} associated with the table's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layerView Read more...} */ readonly layerView: LayerView | nullish; /** * This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#maxSize Read more...} */ maxSize: number | nullish; /** * Set this object to customize the feature table's menu content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#menuConfig Read more...} */ menuConfig: TableMenuConfig | nullish; /** * Controls whether the table allows multiple selected rows. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multipleSelectionEnabled Read more...} */ multipleSelectionEnabled: boolean; /** * This property can be used to determine how newly sorted columns are prioritized. * * @default "prepend" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multipleSortPriority Read more...} */ multipleSortPriority: "append" | "prepend"; /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multiSortEnabled Read more...} */ multiSortEnabled: boolean; /** * This property controls the scale of all components in the navigation bar displayed when * viewing attachments or related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#navigationScale Read more...} */ navigationScale: "s" | "m" | "l"; /** * This property can be used to override the text displayed when the table is fully loaded but no rows are available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#noDataMessage Read more...} */ noDataMessage: string | nullish; /** * An array of field names from the table's data source to include when the table requests data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#outFields Read more...} */ outFields: string[] | nullish; /** * Number of pages of features to be displayed in the table, based on the total {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#size number of features} and configured {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageSize pageSize}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageCount Read more...} */ readonly pageCount: number; /** * Represents the index of the page of the feature currently being displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageIndex Read more...} */ pageIndex: number; /** * The default page size used when displaying features within the table. * * @default 50 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageSize Read more...} */ pageSize: number; /** * Controls whether the table should only display a single page of features at any time. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#paginationEnabled Read more...} */ paginationEnabled: boolean; /** * Indicates whether to display any related records associated with rows within the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedRecordsEnabled Read more...} */ relatedRecordsEnabled: boolean; /** * A nested table instance which represents a relationship to another table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedTable Read more...} */ relatedTable: FeatureTable | nullish; /** * A collection of nested table instances. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedTables Read more...} */ relatedTables: Collection; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html relationship columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relationshipColumns Read more...} */ readonly relationshipColumns: RelationshipColumn[]; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnGeometryEnabled Read more...} */ returnGeometryEnabled: boolean; /** * Indicates whether geometries fetched for the corresponding features contain M values, if supported. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnMEnabled Read more...} */ returnMEnabled: boolean; /** * Indicates whether the fetched features' geometries contain Z values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnZEnabled Read more...} */ returnZEnabled: boolean; /** * Total number of records currently displayed in the table. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#size Read more...} */ readonly size: number; /** * The state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#state Read more...} */ readonly state: "disabled" | "loading" | "loaded" | "ready" | "error"; /** * Indicates whether the table and associated layer support adding attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#supportsAddAttachments Read more...} */ readonly supportsAddAttachments: boolean; /** * Indicates whether the table and associated layer support viewing attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#supportsAttachments Read more...} */ readonly supportsAttachments: boolean; /** * Indicates whether the table and associated layer support deleting attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#supportsDeleteAttachments Read more...} */ readonly supportsDeleteAttachments: boolean; /** * Defines whether or not the feature supports resizing * attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#supportsResizeAttachments Read more...} */ readonly supportsResizeAttachments: boolean; /** * Indicates whether the table and associated layer support updating attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#supportsUpdateAttachments Read more...} */ readonly supportsUpdateAttachments: boolean; /** * Indicates whether the table should synchronize the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attributeTableTemplate attributeTableTemplate} being used based on * changes made to the table's UI. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#syncTemplateOnChangesEnabled Read more...} */ syncTemplateOnChangesEnabled: boolean; /** * A reference to top-level controller table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableController Read more...} */ tableController: FeatureTable | nullish; /** * A reference to the instance of a table widget that is directly associated with this table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableParent Read more...} */ tableParent: FeatureTable | nullish; /** * Dates and times displayed in the widget will be in terms of this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeZone Read more...} */ timeZone: string | nullish; /** * Replacement title for the table widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#title Read more...} */ title: string | Function | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html LinkChartView}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#view Read more...} */ view: MapView | LinkChartView | SceneView | nullish; /** * A flattened array of all top-level visible columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#visibleColumns Read more...} */ readonly visibleColumns: Column[]; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#visibleElements Read more...} */ visibleElements: FeatureTableVisibleElements; /** * The FeatureTable's functionality is described in the following sections:. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html Read more...} */ constructor(properties?: FeatureTableProperties); /** * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Set this property to filter the features displayed in the table. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#filterGeometry Read more...} */ get filterGeometry(): GeometryUnion | nullish; set filterGeometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * A collection of string values which indicate {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field.names} that should be hidden within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#hiddenFields Read more...} */ get hiddenFields(): Collection; set hiddenFields(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#highlightIds Read more...} */ get highlightIds(): Collection; set highlightIds(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#objectIds Read more...} */ get objectIds(): Collection; set objectIds(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#rowHighlightIds Read more...} */ get rowHighlightIds(): Collection; set rowHighlightIds(value: CollectionProperties); /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html template} used for the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableTemplate Read more...} */ get tableTemplate(): TableTemplate | nullish; set tableTemplate(value: TableTemplateProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html TimeExtent} in which to filter and display data within the FeatureTable widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#viewModel Read more...} */ get viewModel(): FeatureTableViewModel; set viewModel(value: FeatureTableViewModelProperties); /** * Clears the current selection filter within the table. * * @deprecated since version 4.30. Use [`filterBySelectionEnabled`](#filterBySelectionEnabled) or [`objectIds`](#objectIds) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#clearSelectionFilter Read more...} */ clearSelectionFilter(): void; /** * Deletes all the selected rows from the table. * * @param showWarningPrompt Indicates whether to display a prompt warning that the selected features will be deleted. Default behavior is to show a warning dialog before proceeding. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#deleteSelection Read more...} */ deleteSelection(showWarningPrompt?: boolean): Promise; /** * Exports features associated with currently selected rows to a CSV file and displays a download prompt. * * @param includeGeometry Indicates whether the geometry should be included in the exported file. Only applicable to features with `point` geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#exportSelectionToCSV Read more...} */ exportSelectionToCSV(includeGeometry?: boolean): Promise; /** * Filters the table using the current row selection and displays only the selected table rows. * * @deprecated since version 4.30. Use [`filterBySelectionEnabled`](#filterBySelectionEnabled) or [`objectIds`](#objectIds) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#filterBySelection Read more...} */ filterBySelection(): void; /** * Finds the specified column within the feature table. * * @param fieldName The `fieldName` of the column to find. This should match the field name as defined at the feature service level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#findColumn Read more...} */ findColumn(fieldName: string): Column | GroupColumn | ActionColumn | AttachmentsColumn | RelationshipColumn | nullish; /** * Instructs the table to scroll to or display a specific page of data. * * @param index Index of the page the table should display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#goToPage Read more...} */ goToPage(index: number): void; /** * Hides the specified column from the feature table. * * @param fieldName The field name of the column to hide. This should match the field name as defined by the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#hideColumn Read more...} */ hideColumn(fieldName: string): void; /** * Instructs the table to scroll to or display the next page of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#nextPage Read more...} */ nextPage(): void; /** * Instructs the table to scroll to or display the previous page of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#previousPage Read more...} */ previousPage(): void; /** * Refreshes the table contents while maintaining the current scroll position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#refresh Read more...} */ refresh(): Promise; /** * Re-renders the cell's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#refreshCellContent Read more...} */ refreshCellContent(): void; /** * Resets the horizontal scroll position of the table to the default view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#scrollLeft Read more...} */ scrollLeft(): void; /** * Scrolls the table to the bottom row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#scrollToBottom Read more...} */ scrollToBottom(): void; /** * Scrolls the table to a row based on a specified index. * * @param index Index of the row in which the table should scroll. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#scrollToIndex Read more...} */ scrollToIndex(index: number): void; /** * Scrolls the table to a row based on a specified object ID. * * @param objectId Object id of a row's associated feature in which the table should scroll. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#scrollToRow Read more...} */ scrollToRow(objectId: number): void; /** * Scrolls the table to the top row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#scrollToTop Read more...} */ scrollToTop(): void; /** * Shows all of the columns in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#showAllColumns Read more...} */ showAllColumns(): void; /** * Shows the specified column within the feature table. * * @param fieldName The `fieldName` of the column to show. This should match the field name as defined at the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#showColumn Read more...} */ showColumn(fieldName: string): void; /** * Sorts the column in either ascending ("asc") or descending ("desc") order. * * @param fieldName The specified field name to sort. This should match the field name as defined at the data source. * @param direction The direction to sort. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#sortColumn Read more...} */ sortColumn(fieldName: string, direction: "asc" | "desc" | nullish): void; /** * Toggles current visibility of the provided column. * * @param fieldName Associated field name of the column to be hidden or made visible. This should match the field name as defined at the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#toggleColumnVisibility Read more...} */ toggleColumnVisibility(fieldName: string): void; /** * Zooms the view to the extent of the current row selection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#zoomToSelection Read more...} */ zoomToSelection(): void; on(name: "cell-click", eventHandler: FeatureTableCellClickEventHandler): IHandle; on(name: "cell-dblclick", eventHandler: FeatureTableCellDblclickEventHandler): IHandle; on(name: "cell-pointerout", eventHandler: FeatureTableCellPointeroutEventHandler): IHandle; on(name: "cell-pointerover", eventHandler: FeatureTableCellPointeroverEventHandler): IHandle; on(name: "cell-keydown", eventHandler: FeatureTableCellKeydownEventHandler): IHandle; on(name: "column-reorder", eventHandler: FeatureTableColumnReorderEventHandler): IHandle; } interface FeatureTableProperties extends WidgetProperties { /** * Configuration for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html ActionColumn}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#actionColumnConfig Read more...} */ actionColumnConfig?: ActionColumnConfig | nullish; /** * Indicates whether to display the `Attachments` field in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attachmentsEnabled Read more...} */ attachmentsEnabled?: boolean; /** * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * Indicates whether the table should automatically refresh when the underlying data changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#autoRefreshEnabled Read more...} */ autoRefreshEnabled?: boolean; /** * Indicates whether to enable the table's column performance mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#columnPerformanceModeEnabled Read more...} */ columnPerformanceModeEnabled?: boolean; /** * Indicates whether the table should allow reordering of columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#columnReorderingEnabled Read more...} */ columnReorderingEnabled?: boolean; /** * The SQL where clause used to filter features visible in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * Text displayed in the table header, under the title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#description Read more...} */ description?: string | Function | nullish; /** * Indicates whether the table is disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#disabled Read more...} */ disabled?: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#editing-in-featuretable editing} is enabled on the data within the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#editingEnabled Read more...} */ editingEnabled?: boolean; /** * Indicates whether the table only displays rows that are considered selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#filterBySelectionEnabled Read more...} */ filterBySelectionEnabled?: boolean; /** * Set this property to filter the features displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#filterGeometry Read more...} */ filterGeometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * A collection of string values which indicate {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field.names} that should be hidden within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#hiddenFields Read more...} */ hiddenFields?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected by checking the corresponding checkbox. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#highlightEnabled Read more...} */ highlightEnabled?: boolean; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#highlightIds Read more...} */ highlightIds?: CollectionProperties; /** * The string value which indicates the displayed [icon](https://doc.geoscene.cn/calcite-design-system/icons/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#icon Read more...} */ icon?: string; /** * The user-provided number of total features accessed from the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#initialSize Read more...} */ initialSize?: number | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#label Read more...} */ label?: string; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layer Read more...} */ layer?: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | Sublayer | nullish; /** * An array of layers listed within the [dropdown component](https://doc.geoscene.cn/calcite-design-system/components/dropdown/) of the table's header. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#layers Read more...} */ layers?: | ( | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer )[] | nullish; /** * This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#maxSize Read more...} */ maxSize?: number | nullish; /** * Set this object to customize the feature table's menu content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#menuConfig Read more...} */ menuConfig?: TableMenuConfig | nullish; /** * Controls whether the table allows multiple selected rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multipleSelectionEnabled Read more...} */ multipleSelectionEnabled?: boolean; /** * This property can be used to determine how newly sorted columns are prioritized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multipleSortPriority Read more...} */ multipleSortPriority?: "append" | "prepend"; /** * Indicates whether sorting multiple columns is supported within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multiSortEnabled Read more...} */ multiSortEnabled?: boolean; /** * This property controls the scale of all components in the navigation bar displayed when * viewing attachments or related records. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#navigationScale Read more...} */ navigationScale?: "s" | "m" | "l"; /** * This property can be used to override the text displayed when the table is fully loaded but no rows are available. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#noDataMessage Read more...} */ noDataMessage?: string | nullish; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#objectIds Read more...} */ objectIds?: CollectionProperties; /** * An array of field names from the table's data source to include when the table requests data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Represents the index of the page of the feature currently being displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageIndex Read more...} */ pageIndex?: number; /** * The default page size used when displaying features within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#pageSize Read more...} */ pageSize?: number; /** * Controls whether the table should only display a single page of features at any time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#paginationEnabled Read more...} */ paginationEnabled?: boolean; /** * Indicates whether to display any related records associated with rows within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedRecordsEnabled Read more...} */ relatedRecordsEnabled?: boolean; /** * A nested table instance which represents a relationship to another table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedTable Read more...} */ relatedTable?: FeatureTable | nullish; /** * A collection of nested table instances. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#relatedTables Read more...} */ relatedTables?: Collection; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnGeometryEnabled Read more...} */ returnGeometryEnabled?: boolean; /** * Indicates whether geometries fetched for the corresponding features contain M values, if supported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnMEnabled Read more...} */ returnMEnabled?: boolean; /** * Indicates whether the fetched features' geometries contain Z values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#returnZEnabled Read more...} */ returnZEnabled?: boolean; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#rowHighlightIds Read more...} */ rowHighlightIds?: CollectionProperties; /** * Indicates whether the table should synchronize the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#attributeTableTemplate attributeTableTemplate} being used based on * changes made to the table's UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#syncTemplateOnChangesEnabled Read more...} */ syncTemplateOnChangesEnabled?: boolean; /** * A reference to top-level controller table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableController Read more...} */ tableController?: FeatureTable | nullish; /** * A reference to the instance of a table widget that is directly associated with this table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableParent Read more...} */ tableParent?: FeatureTable | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html template} used for the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#tableTemplate Read more...} */ tableTemplate?: TableTemplateProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html TimeExtent} in which to filter and display data within the FeatureTable widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * Dates and times displayed in the widget will be in terms of this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeZone Read more...} */ timeZone?: string | nullish; /** * Replacement title for the table widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#title Read more...} */ title?: string | Function | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html LinkChartView}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#view Read more...} */ view?: MapView | LinkChartView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#viewModel Read more...} */ viewModel?: FeatureTableViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#visibleElements Read more...} */ visibleElements?: FeatureTableVisibleElements; } export class ActionColumn extends Accessor { /** * Function invoked when an individual action is clicked or pressed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#callback Read more...} */ callback: ActionColumnCallback; /** * Indicates if the action should appear disabled. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#disabled Read more...} */ disabled: ActionColumnDisabledFunction | boolean | nullish; /** * Icon used by each action. * * @default "pencil" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#icon Read more...} */ icon: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html ActionColumn} class works * with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} and is designed specifically for * displaying a singular [Calcite Action](https://doc.geoscene.cn/calcite-design-system/components/action/) component for each row in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html Read more...} */ constructor(properties?: ActionColumnProperties); } interface ActionColumnProperties { /** * Function invoked when an individual action is clicked or pressed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#callback Read more...} */ callback?: ActionColumnCallback; /** * Indicates if the action should appear disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#disabled Read more...} */ disabled?: ActionColumnDisabledFunction | boolean | nullish; /** * Icon used by each action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html#icon Read more...} */ icon?: string; } export type ActionColumnCallback = (params: ActionColumnCallbackParams) => void; export type ActionColumnDisabledFunction = (params: ActionColumnDisabledFunctionParams) => boolean; export interface ActionColumnCallbackParams { feature: Graphic; index: number; native: any; } export interface ActionColumnDisabledFunctionParams { feature: Graphic; index: number; } export class AttachmentsColumn extends Accessor { /** * The sanitized label displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the attachments column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#effectiveLabel Read more...} */ readonly effectiveLabel: string; /** * The [Calcite Icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the attachments column. * * @default "attachment" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#icon Read more...} */ icon: string; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#layer Read more...} */ layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | nullish; /** * Indicates whether the attachments column is sortable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#sortable Read more...} */ readonly sortable: boolean; /** * The text alignment of the attachments column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#textAlign Read more...} */ readonly textAlign: string; /** * Attempts to display attachment thumbnail previews as images instead of generic icons. * * @default "image" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailAppearance Read more...} */ thumbnailAppearance: "image" | "icon"; /** * Controls the number of attachment thumbnail previews to display in each cell. * * @default 8 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailCount Read more...} */ thumbnailCount: number; /** * Controls the scale of attachment thumbnail icons. * * @default s * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailIconScale Read more...} */ thumbnailIconScale: string; /** * Controls if attachments thumbnail previews are rendered in each cell. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailsEnabled Read more...} */ thumbnailsEnabled: boolean; /** * The `AttachmentsColumn` class works with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} to display attachment counts for each feature in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html Read more...} */ constructor(properties?: AttachmentsColumnProperties); } interface AttachmentsColumnProperties { /** * The [Calcite Icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the attachments column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#icon Read more...} */ icon?: string; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#layer Read more...} */ layer?: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | nullish; /** * Attempts to display attachment thumbnail previews as images instead of generic icons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailAppearance Read more...} */ thumbnailAppearance?: "image" | "icon"; /** * Controls the number of attachment thumbnail previews to display in each cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailCount Read more...} */ thumbnailCount?: number; /** * Controls the scale of attachment thumbnail icons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailIconScale Read more...} */ thumbnailIconScale?: string; /** * Controls if attachments thumbnail previews are rendered in each cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html#thumbnailsEnabled Read more...} */ thumbnailsEnabled?: boolean; } export class FeatureTableViewModel extends Accessor { /** * Reference to the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html action column}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#actionColumn Read more...} */ readonly actionColumn: ActionColumn | nullish; /** * Configuration for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html ActionColumn}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#actionColumnConfig Read more...} */ actionColumnConfig: ActionColumnConfig | nullish; /** * A read-only property indicating the type of filter used by the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#activeFilters Read more...} */ readonly activeFilters: Collection; /** * Use this read-only property if needing to query features while retaining a column's sort order. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#activeSortOrders Read more...} */ readonly activeSortOrders: ColumnSortOrder[]; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#allColumns Read more...} */ readonly allColumns: Column[]; /** * Indicates the table is displaying all related tables in `show all` mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#allRelatedTablesVisible Read more...} */ readonly allRelatedTablesVisible: boolean; /** * A flattened array of all visible {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#allVisibleColumns Read more...} */ readonly allVisibleColumns: Column[]; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html attachment columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsColumns Read more...} */ readonly attachmentsColumns: AttachmentsColumn[]; /** * Indicates whether to display the `Attachments` field in the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsEnabled Read more...} */ attachmentsEnabled: boolean; /** * This read-only property provides the the configuration options for the attachments view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsViewOptions Read more...} */ readonly attachmentsViewOptions: AttachmentsViewOptions; /** * Indicates whether the table should automatically refresh when the underlying data changes. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#autoRefreshEnabled Read more...} */ autoRefreshEnabled: boolean; /** * Indicates whether to enable the table's column performance mode. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#columnPerformanceModeEnabled Read more...} */ columnPerformanceModeEnabled: boolean; /** * Indicates if columns can be reordered by dragging the column's header. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#columnReorderingEnabled Read more...} */ columnReorderingEnabled: boolean; /** * A read-only collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html column}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html field}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html group}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html action}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html attachment}, and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html relationship} columns that are displayed within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#columns Read more...} */ readonly columns: Collection< Column | FieldColumn | GroupColumn | ActionColumn | AttachmentsColumn | RelationshipColumn >; /** * The SQL where clause used to filter features visible in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#definitionExpression Read more...} */ definitionExpression: string | nullish; /** * Indicates whether editing is enabled on the data within the feature table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#editingEnabled Read more...} */ editingEnabled: boolean; /** * The total number of records displayed in the table's current view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#effectiveSize Read more...} */ readonly effectiveSize: number; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html field columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#fieldColumns Read more...} */ readonly fieldColumns: FieldColumn[]; /** * Indicates whether the table only displays rows that are considered selected. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled Read more...} */ filterBySelectionEnabled: boolean; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html group columns} within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#groupColumns Read more...} */ readonly groupColumns: GroupColumn[]; /** * Indicates whether to highlight the associated feature when a row is selected. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled Read more...} */ highlightEnabled: boolean; /** * The user-provided number of total features accessed from the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#initialSize Read more...} */ initialSize: number | nullish; /** * Indicates the table is displaying an editable input in one of its cells. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isEditing Read more...} */ isEditing: boolean; /** * Indicates if the table is querying data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isQuerying Read more...} */ readonly isQuerying: boolean; /** * Indicates if the table is querying or syncing data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isQueryingOrSyncing Read more...} */ readonly isQueryingOrSyncing: boolean; /** * Indicates if the table is syncing data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isSyncing Read more...} */ readonly isSyncing: boolean; /** * Indicates if the table is syncing attachment edits. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isSyncingAttachments Read more...} */ readonly isSyncingAttachments: boolean; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing * the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layer Read more...} */ layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | Sublayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} displaying data for the table's associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layerView Read more...} */ readonly layerView: LayerView | nullish; /** * This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#maxSize Read more...} */ maxSize: number | nullish; /** * Controls whether the table allows multiple selected rows. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multipleSelectionEnabled Read more...} */ multipleSelectionEnabled: boolean; /** * This property can be used to determine how newly sorted columns are prioritized. * * @default "prepend" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multipleSortPriority Read more...} */ multipleSortPriority: "append" | "prepend"; /** * Indicates whether sorting multiple columns is supported within the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multiSortEnabled Read more...} */ multiSortEnabled: boolean; /** * An array of field names from the table's data source to include when the table requests data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#outFields Read more...} */ outFields: string[] | nullish; /** * Number of pages of features to be displayed in the table, based on the total {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#size number of features} and configured {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageSize pageSize}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageCount Read more...} */ readonly pageCount: number; /** * Represents the index of the page of the feature currently being displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageIndex Read more...} */ pageIndex: number; /** * The default page size used when displaying features within the table. * * @default 50 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageSize Read more...} */ pageSize: number; /** * Controls whether the table should only display a single page of features at any time. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled Read more...} */ paginationEnabled: boolean; /** * Indicates whether to display any related records associated with rows within the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedRecordsEnabled Read more...} */ relatedRecordsEnabled: boolean; /** * A nested table instance which represents a relationship to another table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedTable Read more...} */ relatedTable: FeatureTable | nullish; /** * A collection of nested table instances. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedTables Read more...} */ relatedTables: Collection; /** * A flattened array of all {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html relationship columns} within the table, including nested columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relationshipColumns Read more...} */ readonly relationshipColumns: RelationshipColumn[]; /** * An array of relationships that exist on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relationships Read more...} */ relationships: Relationship[] | nullish; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnGeometryEnabled Read more...} */ returnGeometryEnabled: boolean; /** * Indicates whether geometries fetched for the corresponding features contain M values, if supported. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnMEnabled Read more...} */ returnMEnabled: boolean; /** * Indicates whether the fetched features' geometries contain Z values. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnZEnabled Read more...} */ returnZEnabled: boolean; /** * Total number of records currently displayed in the table. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#size Read more...} */ readonly size: number; /** * The state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#state Read more...} */ readonly state: "disabled" | "loading" | "loaded" | "ready" | "error"; /** * Indicates whether the table and associated layer support adding attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#supportsAddAttachments Read more...} */ readonly supportsAddAttachments: boolean; /** * Indicates whether the table supports viewing attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#supportsAttachments Read more...} */ readonly supportsAttachments: boolean; /** * Indicates whether the table and associated layer support deleting attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#supportsDeleteAttachments Read more...} */ readonly supportsDeleteAttachments: boolean; /** * Defines whether or not the feature supports resizing * attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#supportsResizeAttachments Read more...} */ readonly supportsResizeAttachments: boolean; /** * Indicates whether the table and associated layer support updating attachments with the current configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#supportsUpdateAttachments Read more...} */ readonly supportsUpdateAttachments: boolean; /** * Indicates whether the table should synchronize the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate attributeTableTemplate} being used based on * changes made to the table's UI. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#syncTemplateOnChangesEnabled Read more...} */ syncTemplateOnChangesEnabled: boolean; /** * Dates and times displayed in the widget will be in terms of this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#timeZone Read more...} */ timeZone: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * A flattened array of all top-level visible columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#visibleColumns Read more...} */ readonly visibleColumns: Column[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-feature-table/ component}, which allows users to view content from feature attributes in a tabular format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html Read more...} */ constructor(properties?: FeatureTableViewModelProperties); /** * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate Read more...} */ get attributeTableTemplate(): AttributeTableTemplate | nullish; set attributeTableTemplate(value: AttributeTableTemplateProperties | nullish); /** * Set this property to filter the features displayed in the table. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry Read more...} */ get filterGeometry(): GeometryUnion | nullish; set filterGeometry(value: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish); /** * A collection of string {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field.names} that are to remain hidden within the table. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#hiddenFields Read more...} */ get hiddenFields(): Collection; set hiddenFields(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds Read more...} */ get highlightIds(): Collection; set highlightIds(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#objectIds Read more...} */ get objectIds(): Collection; set objectIds(value: CollectionProperties); /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#rowHighlightIds Read more...} */ get rowHighlightIds(): Collection; set rowHighlightIds(value: CollectionProperties); /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html template} used for the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate Read more...} */ get tableTemplate(): TableTemplate | nullish; set tableTemplate(value: TableTemplateProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html TimeExtent} in which to filter and display data within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Clears the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection filterBySelection} so that the table displays all of the table rows. * * @deprecated since version 4.30. Use [`filterBySelectionEnabled`](#filterBySelectionEnabled) or [`objectIds()`](#objectIds) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#clearSelectionFilter Read more...} */ clearSelectionFilter(): void; /** * Deletes all the selected rows from the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#deleteSelection Read more...} */ deleteSelection(): Promise; /** * Exports features associated with currently selected rows to a CSV file and displays a download prompt. * * @param includeGeometry Indicates whether the geometry should be included in the exported file. Only applies to features with 'point' geometries. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#exportSelectionToCSV Read more...} */ exportSelectionToCSV(includeGeometry?: boolean): Promise; /** * Filters the table using the current row selection and displays only those selected table rows. * * @deprecated since version 4.30. Use [`filterBySelectionEnabled`](#filterBySelectionEnabled) or [`objectIds`](#objectIds) instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelection Read more...} */ filterBySelection(): void; /** * Returns the current row index for the associated feature. * * @param objectId The `ObjectId` field of the specified feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#getObjectIdIndex Read more...} */ getObjectIdIndex(objectId: number | string): number; /** * Returns a field value given the specified feature `object` and an associated `fieldName`. * * @param objectId The object ID field of the specified feature. * @param fieldName The name of the field in which to get the associated object id's feature value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#getValue Read more...} */ getValue(objectId: number, fieldName: string): string | number | nullish; /** * Instructs the table to scroll to or display a specific page of data. * * @param index The page index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#goToPage Read more...} */ goToPage(index: number): void; /** * Internal method used to hide the attachments view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#hideAttachmentsView Read more...} */ hideAttachmentsView(): void; /** * Instructs the table to scroll to or display the next page of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#nextPage Read more...} */ nextPage(): void; /** * Instructs the table to scroll to or display the previous page of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#previousPage Read more...} */ previousPage(): void; /** * Refreshes the table contents while maintaining the current scroll position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#refresh Read more...} */ refresh(): void; /** * Re-renders the cell's content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#refreshCellContent Read more...} */ refreshCellContent(): void; /** * Performs a light refresh of cell content, emptying the store and fetching fresh data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#refreshPageCache Read more...} */ refreshPageCache(): void; /** * Performs a full reset of the entire table resulting in the table scrolling to the top-most row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#reset Read more...} */ reset(): void; /** * Resets the horizontal scroll position of the table to the default view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#scrollLeft Read more...} */ scrollLeft(): void; /** * Scrolls the table to the bottom row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#scrollToBottom Read more...} */ scrollToBottom(): void; /** * Scrolls the table to a row based on a specified index. * * @param index Index of the row in which the table should scroll. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#scrollToIndex Read more...} */ scrollToIndex(index: number): void; /** * Scrolls the table to a row based on a specified object ID. * * @param objectId Object id of a row's associated feature in which the table should scroll. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#scrollToRow Read more...} */ scrollToRow(objectId: number): void; /** * Scrolls the table to the top row. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#scrollToTop Read more...} */ scrollToTop(): void; /** * Manually sync the provided layer's attributeTableTemplate with the current state of the FeatureTable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#syncAttributeTableTemplate Read more...} */ syncAttributeTableTemplate(): void; /** * Toggles current visibility of the provided column. * * @param fieldName Associated field name of the column to be hidden or made visible. This should match the field name as defined at the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#toggleColumnVisibility Read more...} */ toggleColumnVisibility(fieldName: string): void; /** * Zooms the view to the extent of the current row selection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#zoomToSelection Read more...} */ zoomToSelection(): void; on(name: "cell-click", eventHandler: FeatureTableViewModelCellClickEventHandler): IHandle; on(name: "cell-dblclick", eventHandler: FeatureTableViewModelCellDblclickEventHandler): IHandle; on(name: "cell-pointerout", eventHandler: FeatureTableViewModelCellPointeroutEventHandler): IHandle; on(name: "cell-pointerover", eventHandler: FeatureTableViewModelCellPointeroverEventHandler): IHandle; on(name: "cell-keydown", eventHandler: FeatureTableViewModelCellKeydownEventHandler): IHandle; on(name: "column-reorder", eventHandler: FeatureTableViewModelColumnReorderEventHandler): IHandle; } interface FeatureTableViewModelProperties { /** * Configuration for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-ActionColumn.html ActionColumn}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#actionColumnConfig Read more...} */ actionColumnConfig?: ActionColumnConfig | nullish; /** * Indicates whether to display the `Attachments` field in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attachmentsEnabled Read more...} */ attachmentsEnabled?: boolean; /** * Use this property to configure how columns display within the table in regard to visibility, column order, and sorting. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate Read more...} */ attributeTableTemplate?: AttributeTableTemplateProperties | nullish; /** * Indicates whether the table should automatically refresh when the underlying data changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#autoRefreshEnabled Read more...} */ autoRefreshEnabled?: boolean; /** * Indicates whether to enable the table's column performance mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#columnPerformanceModeEnabled Read more...} */ columnPerformanceModeEnabled?: boolean; /** * Indicates if columns can be reordered by dragging the column's header. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#columnReorderingEnabled Read more...} */ columnReorderingEnabled?: boolean; /** * The SQL where clause used to filter features visible in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#definitionExpression Read more...} */ definitionExpression?: string | nullish; /** * Indicates whether editing is enabled on the data within the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#editingEnabled Read more...} */ editingEnabled?: boolean; /** * Indicates whether the table only displays rows that are considered selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterBySelectionEnabled Read more...} */ filterBySelectionEnabled?: boolean; /** * Set this property to filter the features displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#filterGeometry Read more...} */ filterGeometry?: | (ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" }) | nullish; /** * A collection of string {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html field.names} that are to remain hidden within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#hiddenFields Read more...} */ hiddenFields?: CollectionProperties; /** * Indicates whether to highlight the associated feature when a row is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#highlightEnabled Read more...} */ highlightEnabled?: boolean; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#highlightIds Read more...} */ highlightIds?: CollectionProperties; /** * The user-provided number of total features accessed from the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#initialSize Read more...} */ initialSize?: number | nullish; /** * Indicates the table is displaying an editable input in one of its cells. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#isEditing Read more...} */ isEditing?: boolean; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing * the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layer Read more...} */ layer?: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | OrientedImageryLayer | Sublayer | nullish; /** * This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#maxSize Read more...} */ maxSize?: number | nullish; /** * Controls whether the table allows multiple selected rows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multipleSelectionEnabled Read more...} */ multipleSelectionEnabled?: boolean; /** * This property can be used to determine how newly sorted columns are prioritized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multipleSortPriority Read more...} */ multipleSortPriority?: "append" | "prepend"; /** * Indicates whether sorting multiple columns is supported within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#multiSortEnabled Read more...} */ multiSortEnabled?: boolean; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#objectIds Read more...} */ objectIds?: CollectionProperties; /** * An array of field names from the table's data source to include when the table requests data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Represents the index of the page of the feature currently being displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageIndex Read more...} */ pageIndex?: number; /** * The default page size used when displaying features within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#pageSize Read more...} */ pageSize?: number; /** * Controls whether the table should only display a single page of features at any time. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#paginationEnabled Read more...} */ paginationEnabled?: boolean; /** * Indicates whether to display any related records associated with rows within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedRecordsEnabled Read more...} */ relatedRecordsEnabled?: boolean; /** * A nested table instance which represents a relationship to another table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedTable Read more...} */ relatedTable?: FeatureTable | nullish; /** * A collection of nested table instances. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relatedTables Read more...} */ relatedTables?: Collection; /** * An array of relationships that exist on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#relationships Read more...} */ relationships?: Relationship[] | nullish; /** * Indicates whether to fetch geometries for the corresponding features displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnGeometryEnabled Read more...} */ returnGeometryEnabled?: boolean; /** * Indicates whether geometries fetched for the corresponding features contain M values, if supported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnMEnabled Read more...} */ returnMEnabled?: boolean; /** * Indicates whether the fetched features' geometries contain Z values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#returnZEnabled Read more...} */ returnZEnabled?: boolean; /** * This property accepts and returns a collection of feature object IDs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#rowHighlightIds Read more...} */ rowHighlightIds?: CollectionProperties; /** * Indicates whether the table should synchronize the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#attributeTableTemplate attributeTableTemplate} being used based on * changes made to the table's UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#syncTemplateOnChangesEnabled Read more...} */ syncTemplateOnChangesEnabled?: boolean; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html template} used for the feature table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#tableTemplate Read more...} */ tableTemplate?: TableTemplateProperties | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeExtent.html TimeExtent} in which to filter and display data within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * Dates and times displayed in the widget will be in terms of this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#timeZone Read more...} */ timeZone?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * Configuration for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#actionColumn FeatureTable's actionColumn}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#ActionColumnConfig Read more...} */ export interface ActionColumnConfig { icon?: string; label: string; callback: ActionColumnCallback; frozenToEnd?: boolean; disabled?: ActionColumnDisabledFunction | boolean; } export interface FeatureTableViewModelCellClickEvent { feature?: Graphic; fieldName?: string; index?: number; native: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-click"; } export interface FeatureTableViewModelCellDblclickEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-dblclick"; } export interface FeatureTableViewModelCellKeydownEvent { feature?: Graphic; fieldName?: string; index?: number; native: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-keydown"; } export interface FeatureTableViewModelCellPointeroutEvent { feature?: Graphic; fieldName?: string; index?: number; native: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-pointerout"; } export interface FeatureTableViewModelCellPointeroverEvent { feature?: Graphic; fieldName?: string; index?: number; native: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-pointerover"; } export interface FeatureTableViewModelColumnReorderEvent { type: "column-reorder"; } /** * An array of objects containing a column's name and sort direction. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#ColumnSortOrder Read more...} */ export interface ColumnSortOrder { fieldName: string; direction: "asc" | "desc" | nullish; } /** * Use this for spatial filtering, it is the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Geometry.html Geometry} used to filter out data within the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#GeometryFilter Read more...} */ export interface GeometryFilter { type: string; geometry: GeometryUnion; } /** * Use this for selecting rows within the table based off of their object ID. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FeatureTableViewModel.html#SelectionFilter Read more...} */ export interface SelectionFilter { type: string; objectIds: (number | string)[]; } export interface FieldColumn extends Accessor, Column { } export class FieldColumn { /** * The display name for the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#alias Read more...} */ readonly alias: string | nullish; /** * The default value set for the field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#defaultValue Read more...} */ readonly defaultValue: number | string | nullish; /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#editable Read more...} */ editable: boolean; /** * Custom function for rendering cell content that is called when the column is rendered in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#formatFunction Read more...} */ formatFunction: FieldValueFormatFunction | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#layer Read more...} */ layer: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | nullish; /** * Restricts the input length for the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#maxLength Read more...} */ readonly maxLength: number; /** * Restricts the input length for the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#minLength Read more...} */ readonly minLength: number | nullish; /** * The name of the field. * * @deprecated since version 4.30, use {@link module:geoscene/widgets/FeatureTable/FieldColumn#fieldName FieldColumn.fieldName} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#name Read more...} */ readonly name: string | nullish; /** * Indicates if the field can accept `null` values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#nullable Read more...} */ readonly nullable: boolean; /** * Indicates whether a value is required when editing feature attributes within the table's cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#required Read more...} */ required: boolean; /** * A configurable template for the table column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#template Read more...} */ template: FieldColumnTemplate | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html FieldColumn} class works * with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} and provides the underlying * logic for column behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html Read more...} */ constructor(properties?: FieldColumnProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} associated with this column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#field Read more...} */ get field(): Field; set field(value: FieldProperties); } interface FieldColumnProperties extends ColumnProperties { /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#editable Read more...} */ editable?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Field.html Field} associated with this column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#field Read more...} */ field?: FieldProperties; /** * Custom function for rendering cell content that is called when the column is rendered in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#formatFunction Read more...} */ formatFunction?: FieldValueFormatFunction | nullish; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-catalog-CatalogFootprintLayer.html CatalogFootprintLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-ImageryLayer.html ImageryLayer}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-knowledgeGraph-KnowledgeGraphSublayer.html KnowledgeGraphSublayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-WFSLayer.html WFSLayer} containing the fields and attributes to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#layer Read more...} */ layer?: | CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer | nullish; /** * Indicates whether a value is required when editing feature attributes within the table's cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#required Read more...} */ required?: boolean; /** * A configurable template for the table column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#template Read more...} */ template?: FieldColumnTemplate | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#view Read more...} */ view?: MapView | SceneView | nullish; } export type FieldValueFormatFunction = ( params: FieldValueFormatFunctionParams, ) => string | number | HTMLElement | nullish; export interface FieldValueFormatFunctionParams { attachments: AttachmentInfo[]; column: Column; feature: Graphic; index: number; relatedRecords: RelatedRecordInfo[]; virtualIndex: number; value: string | number | nullish; field: Field | nullish; } export class Column extends Accessor { /** * Indicates if the column width will automatically adjust to account for large content. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#autoWidth Read more...} */ autoWidth: boolean; /** * Contains information describing the purpose of each column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#description Read more...} */ description: string | nullish; /** * Controls the sort order of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#direction Read more...} */ direction: "asc" | "desc" | nullish; /** * The sanitized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#description description} string, describing the purpose of each column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#effectiveDescription Read more...} */ effectiveDescription: string | nullish; /** * The sanitized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#label label} string safe for display in the header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#effectiveLabel Read more...} */ effectiveLabel: string; /** * The unique field name as defined by the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#fieldName Read more...} */ readonly fieldName: string; /** * Controls the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) property for the column. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#flexGrow Read more...} */ flexGrow: number; /** * Custom function for rendering cell content that is called when the column is rendered in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#formatFunction Read more...} */ readonly formatFunction: FormatFunction | nullish; /** * Indicates if the the column is frozen in place at the beginning of the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#frozen Read more...} */ readonly frozen: boolean; /** * Indicates if the column is frozen in place at the end of the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#frozenToEnd Read more...} */ readonly frozenToEnd: boolean; /** * Indicates whether the column is visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#hidden Read more...} */ hidden: boolean; /** * The string value indicating the [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#icon Read more...} */ icon: string | nullish; /** * The string value displayed when hovering over the associated [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#iconText Read more...} */ iconText: string | nullish; /** * Indicates the initial sort priority of the column when first rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#initialSortPriority Read more...} */ readonly initialSortPriority: number | nullish; /** * Indicates whether the column is in an invalid state. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#invalid Read more...} */ invalid: boolean; /** * The default label displayed in the column header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#label Read more...} */ label: string | nullish; /** * Text displayed when hovering over the column header label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#labelTooltipText Read more...} */ labelTooltipText: string | nullish; /** * The element representing the field column's menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#menu Read more...} */ readonly menu: HTMLElement; /** * Configuration options for the column's menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#menuConfig Read more...} */ readonly menuConfig: ColumnTableMenuConfig | nullish; /** * Indicates whether the column's menu is currently open. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#menuIsOpen Read more...} */ readonly menuIsOpen: boolean; /** * Indicates whether the Column's menu will be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#menuIsVisible Read more...} */ readonly menuIsVisible: boolean; /** * Indicates whether the column is resizable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#resizable Read more...} */ readonly resizable: boolean; /** * Indicates whether the column is sortable. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#sortable Read more...} */ sortable: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeZone timeZone} of the parent table widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#tableTimeZone Read more...} */ tableTimeZone: string | nullish; /** * Aligns the columns cell content horizontally. * * @default "start" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#textAlign Read more...} */ textAlign: "start" | "center" | "end"; /** * Indicates cell content should be wrapped and displayed on multiple lines within the cell. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#textWrap Read more...} */ textWrap: boolean; /** * The [storage IANA time zone](https://www.iana.org/time-zones) of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#timeZone Read more...} */ timeZone: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#VisibleElements visible elements} of the column's associated FeatureTable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#visibleElements Read more...} */ visibleElements: FeatureTableVisibleElements | nullish; /** * Width of the column in pixels. * * @default 200 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#width Read more...} */ width: number | string; /** * The `Column` class works with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} and provides much of the underlying logic for column behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html Read more...} */ constructor(properties?: ColumnProperties); /** * Convenience method for closing the column menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#closeMenu Read more...} */ closeMenu(): void; /** * Convenience method for opening the column menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#openMenu Read more...} */ openMenu(): void; /** * Convenience method for sorting the current column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#sort Read more...} */ sort(): void; } interface ColumnProperties { /** * Indicates if the column width will automatically adjust to account for large content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#autoWidth Read more...} */ autoWidth?: boolean; /** * Contains information describing the purpose of each column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#description Read more...} */ description?: string | nullish; /** * Controls the sort order of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#direction Read more...} */ direction?: "asc" | "desc" | nullish; /** * The sanitized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#description description} string, describing the purpose of each column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#effectiveDescription Read more...} */ effectiveDescription?: string | nullish; /** * The sanitized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#label label} string safe for display in the header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#effectiveLabel Read more...} */ effectiveLabel?: string; /** * The unique field name as defined by the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#fieldName Read more...} */ fieldName?: string; /** * Controls the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) property for the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#flexGrow Read more...} */ flexGrow?: number; /** * Indicates if the the column is frozen in place at the beginning of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#frozen Read more...} */ frozen?: boolean; /** * Indicates if the column is frozen in place at the end of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#frozenToEnd Read more...} */ frozenToEnd?: boolean; /** * Indicates whether the column is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#hidden Read more...} */ hidden?: boolean; /** * The string value indicating the [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#icon Read more...} */ icon?: string | nullish; /** * The string value displayed when hovering over the associated [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#iconText Read more...} */ iconText?: string | nullish; /** * Indicates the initial sort priority of the column when first rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#initialSortPriority Read more...} */ initialSortPriority?: number | nullish; /** * Indicates whether the column is in an invalid state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#invalid Read more...} */ invalid?: boolean; /** * The default label displayed in the column header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#label Read more...} */ label?: string | nullish; /** * Text displayed when hovering over the column header label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#labelTooltipText Read more...} */ labelTooltipText?: string | nullish; /** * Indicates whether the column is sortable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#sortable Read more...} */ sortable?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#timeZone timeZone} of the parent table widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#tableTimeZone Read more...} */ tableTimeZone?: string | nullish; /** * Aligns the columns cell content horizontally. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#textAlign Read more...} */ textAlign?: "start" | "center" | "end"; /** * Indicates cell content should be wrapped and displayed on multiple lines within the cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#textWrap Read more...} */ textWrap?: boolean; /** * The [storage IANA time zone](https://www.iana.org/time-zones) of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#timeZone Read more...} */ timeZone?: string | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#VisibleElements visible elements} of the column's associated FeatureTable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#visibleElements Read more...} */ visibleElements?: FeatureTableVisibleElements | nullish; /** * Width of the column in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#width Read more...} */ width?: number | string; } export interface ColumnTableMenuConfig { disabled?: boolean; items: TableMenuItemConfig[]; open?: boolean; icon?: string; selectionMode?: "none" | "single" | "multiple"; } export type FormatFunction = (params: FormatFunctionParams) => string | number | HTMLElement | nullish; /** * The related records for the associated feature used in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#formatFunction Columns's} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html#FieldValueFormatFunction FieldColumn's} `formatFunction`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html#RelatedRecordInfo Read more...} */ export interface RelatedRecordInfo { relationshipId: number; count: number; } export interface FormatFunctionParams { attachments: AttachmentInfo[]; column: Column; feature: Graphic; index: number; relatedRecords: RelatedRecordInfo[]; virtualIndex: number; value: string | number | nullish; field: Field | nullish; } export interface GroupColumn extends Accessor, Column { } export class GroupColumn { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html columns} to display as grouped which represent an ordered list of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html#columns Read more...} */ readonly columns: Column[] | nullish; /** * The `GroupColumn` class works with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} and provides the underlying logic for grouped column behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#disabled Read more...} */ disabled: boolean; /** * Indicates if the menu content is open and visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#open Read more...} */ open: boolean; /** * This widget provides the underlying menu functionality when working with the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html Read more...} */ constructor(properties?: ButtonMenuProperties); /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#items Read more...} */ get items(): ButtonMenuItem[] | nullish; set items(value: ButtonMenuItemProperties[] | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#viewModel Read more...} */ get viewModel(): ButtonMenuViewModel; set viewModel(value: ButtonMenuViewModelProperties); } interface ButtonMenuProperties extends WidgetProperties { /** * When true, the widget is visually withdrawn and cannot be interacted with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#disabled Read more...} */ disabled?: boolean; /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#items Read more...} */ items?: ButtonMenuItemProperties[] | nullish; /** * Indicates if the menu content is open and visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#open Read more...} */ open?: boolean; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html#viewModel Read more...} */ viewModel?: ButtonMenuViewModelProperties; } export class ButtonMenuItem extends Accessor { /** * Indicates whether to automatically close the menu's item. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#autoCloseMenu Read more...} */ autoCloseMenu: boolean; /** * A function that executes on the ButtonMenuItem's `click` event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#clickFunction Read more...} */ clickFunction: ButtonMenuItemClickFunction | nullish; /** * The label of the menu item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#label Read more...} */ label: string | nullish; /** * Indicates if the menu content is visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#open Read more...} */ open: boolean; /** * Indicates whether the menu item is selected. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selected Read more...} */ selected: boolean; /** * Indicates whether a toggled state should be applied to individual menu items. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selectionEnabled Read more...} */ selectionEnabled: boolean; /** * The `ButtonMenuItem` class provides the underlying menu functionality to create and customize * new menu items within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenu.html ButtonMenu}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html Read more...} */ constructor(properties?: ButtonMenuItemProperties); /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#items Read more...} */ get items(): ButtonMenuItem[] | nullish; set items(value: ButtonMenuItemProperties[] | nullish); } interface ButtonMenuItemProperties { /** * Indicates whether to automatically close the menu's item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#autoCloseMenu Read more...} */ autoCloseMenu?: boolean; /** * A function that executes on the ButtonMenuItem's `click` event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#clickFunction Read more...} */ clickFunction?: ButtonMenuItemClickFunction | nullish; /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#items Read more...} */ items?: ButtonMenuItemProperties[] | nullish; /** * The label of the menu item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#label Read more...} */ label?: string | nullish; /** * Indicates if the menu content is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#open Read more...} */ open?: boolean; /** * Indicates whether the menu item is selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selected Read more...} */ selected?: boolean; /** * Indicates whether a toggled state should be applied to individual menu items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html#selectionEnabled Read more...} */ selectionEnabled?: boolean; } export type ButtonMenuItemClickFunction = (event: ButtonMenuItemClickFunctionEvent) => void; export interface ButtonMenuItemClickFunctionEvent { item: ButtonMenuItem; } export class ButtonMenuViewModel extends Accessor { /** * Indicates if the menu content is visible. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#open Read more...} */ open: boolean; /** * Provides the logic for the module:geoscene/widgets/ButtonMenuItemConfig widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html Read more...} */ constructor(properties?: ButtonMenuViewModelProperties); /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#items Read more...} */ get items(): ButtonMenuItem[] | nullish; set items(value: ButtonMenuItemProperties[] | nullish); } interface ButtonMenuViewModelProperties { /** * An array of individual {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuItem.html menu items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#items Read more...} */ items?: ButtonMenuItemProperties[] | nullish; /** * Indicates if the menu content is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-support-ButtonMenuViewModel.html#open Read more...} */ open?: boolean; } export class RelationshipColumn extends Accessor { /** * Indicates whether the column displays collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#collapsed Read more...} */ collapsed: boolean; /** * The sanitized label displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the relationship column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#effectiveLabel Read more...} */ readonly effectiveLabel: string; /** * The [Calcite Icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the attachments column. * * @default "link" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#icon Read more...} */ icon: string; /** * The layer that contains the features being displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#layer Read more...} */ readonly layer: FeatureLayer | SceneLayer; /** * Returns the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-Relationship.html Relationship} of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relatedLayer relatedlayer} to find a relationship that has the same id as the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relationshipId relationshipId}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#originRelationship Read more...} */ readonly originRelationship: Relationship | nullish; /** * The layer that contains the related features being displayed in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relatedLayer Read more...} */ readonly relatedLayer: FeatureLayer | SceneLayer; /** * Returns the first relationship from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#layer layer's} `relationships` that matches the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relationshipId relationshipId}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relationship Read more...} */ readonly relationship: Relationship | nullish; /** * The unique ID for the relationship. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#relationshipId Read more...} */ readonly relationshipId: number; /** * Indicates whether the relationship column can be resized. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#resizable Read more...} */ readonly resizable: boolean; /** * The text alignment of the relationship column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#textAlign Read more...} */ readonly textAlign: string; /** * Default width of the relationship column in pixels. * * @default "200px" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#width Read more...} */ width: number | string; /** * The `RelationshipColumn` class works with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} to display any associated related records for each feature in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html Read more...} */ constructor(properties?: RelationshipColumnProperties); } interface RelationshipColumnProperties { /** * Indicates whether the column displays collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#collapsed Read more...} */ collapsed?: boolean; /** * The [Calcite Icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} header for the attachments column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#icon Read more...} */ icon?: string; /** * Default width of the relationship column in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html#width Read more...} */ width?: number | string; } export class AttachmentsColumnTemplate extends ColumnTemplateBase { /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsColumnTemplate.html#type Read more...} */ readonly type: "attachment"; /** * A AttachmentsColumnTemplate formats and defines the structure of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-AttachmentsColumn.html AttachmentsColumn} within a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsColumnTemplate.html Read more...} */ constructor(properties?: AttachmentsColumnTemplateProperties); static fromJSON(json: any): AttachmentsColumnTemplate; } interface AttachmentsColumnTemplateProperties extends ColumnTemplateBaseProperties { } export class AttachmentsViewOptions extends Accessor { /** * The ID of the attachment currently being edited. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#attachmentId Read more...} */ readonly attachmentId: number | nullish; /** * An array of attachment information objects. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#attachmentInfos Read more...} */ readonly attachmentInfos: AttachmentInfo[]; /** * A list of file candidates that can be added as attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#candidates Read more...} */ readonly candidates: any | nullish; /** * An error that may occur during attachment operations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#error Read more...} */ readonly error: Error | nullish; /** * The HTML form element used for file uploads. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#form Read more...} */ readonly form: HTMLFormElement | nullish; /** * The current mode of the attachments view. * * @default "list" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#mode Read more...} */ readonly mode: "list" | "file" | nullish; /** * The object ID of the feature associated with the attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#objectId Read more...} */ readonly objectId: number | string | nullish; /** * AttachmentsViewOptions is a read-only class which defines what can be displayed within {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} attachments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html Read more...} */ constructor(properties?: AttachmentsViewOptionsProperties); /** * Used to display the list view and clear temporary file data after a successful edit. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#onEditComplete Read more...} */ onEditComplete(): void; /** * Use this method to reset feature-specific properties after the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#objectId objectId} changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-AttachmentsViewOptions.html#reset Read more...} */ reset(): void; } interface AttachmentsViewOptionsProperties { } export class ColumnTemplate extends ColumnTemplateBase { /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html#editable Read more...} */ editable: boolean; /** * Indicates whether a field requires a value. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html#required Read more...} */ required: boolean; /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html#type Read more...} */ readonly type: "column"; /** * A ColumnTemplate formats and defines the structure of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-Column.html Column} within a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html Read more...} */ constructor(properties?: ColumnTemplateProperties); static fromJSON(json: any): ColumnTemplate; } interface ColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html#editable Read more...} */ editable?: boolean; /** * Indicates whether a field requires a value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplate.html#required Read more...} */ required?: boolean; } export interface ColumnTemplateBase extends Accessor, JSONSupport { } export class ColumnTemplateBase { /** * Indicates if the column width will automatically adjust to account for large content. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#autoWidth Read more...} */ autoWidth: boolean; /** * A string description of the column to give context to what it represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#description Read more...} */ description: string | nullish; /** * Controls the sort order of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#direction Read more...} */ direction: "asc" | "desc" | nullish; /** * The unique field name as defined by the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#fieldName Read more...} */ fieldName: string; /** * Controls the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) property for the column. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#flexGrow Read more...} */ flexGrow: number; /** * Custom function for rendering cell content that is called when the column is rendered in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#formatFunction Read more...} */ formatFunction: FormatFunction | nullish; /** * Indicates if the the column is frozen in place at the beginning of the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#frozen Read more...} */ readonly frozen: boolean; /** * Indicates if the column is frozen in place at the end of the table. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#frozenToEnd Read more...} */ readonly frozenToEnd: boolean; /** * The string value indicating the [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#icon Read more...} */ icon: string | nullish; /** * The string value displayed when hovering over the associated [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#iconText Read more...} */ iconText: string | nullish; /** * Use this in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multiSortEnabled FeatureTable.multiSortEnabled} and FeatureTable.direction properties to set sorting functionality on multiple columns. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority Read more...} */ initialSortPriority: number | nullish; /** * Indicates whether the column is in an invalid state. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#invalid Read more...} */ invalid: boolean; /** * The default label displayed in the column header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#label Read more...} */ label: string | nullish; /** * Text displayed when hovering over the column header label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#labelTooltipText Read more...} */ labelTooltipText: string | nullish; /** * Configuration options for the column menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#menuConfig Read more...} */ menuConfig: ColumnTableMenuConfig | nullish; /** * Indicates whether the column is resizable. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#resizable Read more...} */ resizable: boolean; /** * Indicates whether the column can be sorted. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#sortable Read more...} */ sortable: boolean; /** * Aligns the columns cell content horizontally. * * @default "start" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#textAlign Read more...} */ textAlign: "start" | "center" | "end"; /** * Indicates cell content should be wrapped and displayed on multiple lines within the cell. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#textWrap Read more...} */ textWrap: boolean; /** * The time zone of the specific column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#timeZone Read more...} */ timeZone: string | nullish; /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#type Read more...} */ readonly type: "column" | "field" | "group" | "attachment" | "relationship"; /** * Indicates whether the column is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#visible Read more...} */ visible: boolean; /** * Default width of the column in pixels. * * @default 200 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#width Read more...} */ width: number | string; /** * The base class for all column templates used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html tableTemplate} within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html Read more...} */ constructor(properties?: ColumnTemplateBaseProperties); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): ColumnTemplateBase; } interface ColumnTemplateBaseProperties { /** * Indicates if the column width will automatically adjust to account for large content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#autoWidth Read more...} */ autoWidth?: boolean; /** * A string description of the column to give context to what it represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#description Read more...} */ description?: string | nullish; /** * Controls the sort order of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#direction Read more...} */ direction?: "asc" | "desc" | nullish; /** * The unique field name as defined by the data source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#fieldName Read more...} */ fieldName?: string; /** * Controls the [flex-grow](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow) property for the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#flexGrow Read more...} */ flexGrow?: number; /** * Custom function for rendering cell content that is called when the column is rendered in the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#formatFunction Read more...} */ formatFunction?: FormatFunction | nullish; /** * Indicates if the the column is frozen in place at the beginning of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#frozen Read more...} */ frozen?: boolean; /** * Indicates if the column is frozen in place at the end of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#frozenToEnd Read more...} */ frozenToEnd?: boolean; /** * The string value indicating the [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#icon Read more...} */ icon?: string | nullish; /** * The string value displayed when hovering over the associated [icon](https://doc.geoscene.cn/calcite-design-system/icons/) displayed in the header cell of the column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#iconText Read more...} */ iconText?: string | nullish; /** * Use this in combination with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#multiSortEnabled FeatureTable.multiSortEnabled} and FeatureTable.direction properties to set sorting functionality on multiple columns. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#initialSortPriority Read more...} */ initialSortPriority?: number | nullish; /** * Indicates whether the column is in an invalid state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#invalid Read more...} */ invalid?: boolean; /** * The default label displayed in the column header cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#label Read more...} */ label?: string | nullish; /** * Text displayed when hovering over the column header label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#labelTooltipText Read more...} */ labelTooltipText?: string | nullish; /** * Configuration options for the column menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#menuConfig Read more...} */ menuConfig?: ColumnTableMenuConfig | nullish; /** * Indicates whether the column is resizable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#resizable Read more...} */ resizable?: boolean; /** * Indicates whether the column can be sorted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#sortable Read more...} */ sortable?: boolean; /** * Aligns the columns cell content horizontally. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#textAlign Read more...} */ textAlign?: "start" | "center" | "end"; /** * Indicates cell content should be wrapped and displayed on multiple lines within the cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#textWrap Read more...} */ textWrap?: boolean; /** * The time zone of the specific column. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#timeZone Read more...} */ timeZone?: string | nullish; /** * Indicates whether the column is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#visible Read more...} */ visible?: boolean; /** * Default width of the column in pixels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-ColumnTemplateBase.html#width Read more...} */ width?: number | string; } export class FieldColumnTemplate extends ColumnTemplateBase { /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#editable Read more...} */ editable: boolean; /** * Custom function for rendering cell content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#formatFunction Read more...} */ formatFunction: FieldColumnTemplateFieldValueFormatFunction | nullish; /** * Indicates whether a field requires a value. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#required Read more...} */ required: boolean; /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#type Read more...} */ readonly type: "field"; /** * A FieldColumnTemplate formats and defines the structure of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-FieldColumn.html FieldColumn} within a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html Read more...} */ constructor(properties?: FieldColumnTemplateProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html coded value domain} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html range domain} of the associated field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#domain Read more...} */ get domain(): CodedValueDomain | RangeDomain; set domain(value: (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" })); static fromJSON(json: any): FieldColumnTemplate; } interface FieldColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-CodedValueDomain.html coded value domain} or a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-RangeDomain.html range domain} of the associated field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#domain Read more...} */ domain?: (CodedValueDomainProperties & { type: "coded-value" }) | (RangeDomainProperties & { type: "range" }); /** * Indicates whether the field is editable. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#editable Read more...} */ editable?: boolean; /** * Custom function for rendering cell content. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#formatFunction Read more...} */ formatFunction?: FieldColumnTemplateFieldValueFormatFunction | nullish; /** * Indicates whether a field requires a value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html#required Read more...} */ required?: boolean; } export type FieldColumnTemplateFieldValueFormatFunction = ( params: FieldColumnTemplateFieldValueFormatFunctionParams, ) => string | number | HTMLElement | nullish; export interface FieldColumnTemplateFieldValueFormatFunctionParams { column: Column; feature: Graphic; field: Field | nullish; index: number; value: string | number | nullish; } export class GroupColumnTemplate extends ColumnTemplateBase { /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html#type Read more...} */ readonly type: "group"; /** * A GroupColumnTemplate formats and defines the structure of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-Grid-GroupColumn.html GroupColumn} within a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html Read more...} */ constructor(properties?: GroupColumnTemplateProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html field column templates} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html group column templates} that represent an ordered list of column templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html#columnTemplates Read more...} */ get columnTemplates(): ( | ColumnTemplate | FieldColumnTemplate | AttachmentsColumnTemplate | RelationshipColumnTemplate )[]; set columnTemplates(value: ( | (ColumnTemplateProperties & { type: "column" }) | (FieldColumnTemplateProperties & { type: "field" }) | (AttachmentsColumnTemplateProperties & { type: "attachment" }) | (RelationshipColumnTemplateProperties & { type: "relationship" }) )[]); static fromJSON(json: any): GroupColumnTemplate; } interface GroupColumnTemplateProperties extends ColumnTemplateBaseProperties { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html field column templates} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html group column templates} that represent an ordered list of column templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html#columnTemplates Read more...} */ columnTemplates?: ( | (ColumnTemplateProperties & { type: "column" }) | (FieldColumnTemplateProperties & { type: "field" }) | (AttachmentsColumnTemplateProperties & { type: "attachment" }) | (RelationshipColumnTemplateProperties & { type: "relationship" }) )[]; } export class RelationshipColumnTemplate extends ColumnTemplateBase { /** * The type of column that the template represents. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-RelationshipColumnTemplate.html#type Read more...} */ readonly type: "relationship"; /** * A RelationshipColumnTemplate formats and defines the structure of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-RelationshipColumn.html RelationshipColumn} within a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-RelationshipColumnTemplate.html Read more...} */ constructor(properties?: RelationshipColumnTemplateProperties); static fromJSON(json: any): RelationshipColumnTemplate; } interface RelationshipColumnTemplateProperties extends ColumnTemplateBaseProperties { } export interface TableTemplate extends Accessor, JSONSupport { } export class TableTemplate { /** * A TableTemplate formats and defines the content of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html FeatureTable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html Read more...} */ constructor(properties?: TableTemplateProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html field column templates} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html group column templates} that represent an ordered list of column templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html#columnTemplates Read more...} */ get columnTemplates(): ( | FieldColumnTemplate | GroupColumnTemplate | ColumnTemplate | AttachmentsColumnTemplate | RelationshipColumnTemplate )[]; set columnTemplates(value: ( | (FieldColumnTemplateProperties & { type: "field" }) | (GroupColumnTemplateProperties & { type: "group" }) | (ColumnTemplateProperties & { type: "column" }) | (AttachmentsColumnTemplateProperties & { type: "attachment" }) | (RelationshipColumnTemplateProperties & { type: "relationship" }) )[]); /** * Creates a deep clone of the TableTemplate class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html#clone Read more...} */ clone(): TableTemplate; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): TableTemplate; } interface TableTemplateProperties { /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-FieldColumnTemplate.html field column templates} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-GroupColumnTemplate.html group column templates} that represent an ordered list of column templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable-support-TableTemplate.html#columnTemplates Read more...} */ columnTemplates?: ( | (FieldColumnTemplateProperties & { type: "field" }) | (GroupColumnTemplateProperties & { type: "group" }) | (ColumnTemplateProperties & { type: "column" }) | (AttachmentsColumnTemplateProperties & { type: "attachment" }) | (RelationshipColumnTemplateProperties & { type: "relationship" }) )[]; } export interface FeatureTableCellClickEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-click"; } export interface FeatureTableCellDblclickEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-dblclick"; } export interface FeatureTableCellKeydownEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-keydown"; } export interface FeatureTableCellPointeroutEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-pointerout"; } export interface FeatureTableCellPointeroverEvent { feature?: Graphic; fieldName?: string; index?: number; native?: MouseEvent | PointerEvent | KeyboardEvent; objectId?: number | string; type: "cell-pointerover"; } export interface FeatureTableColumnReorderEvent { type: "column-reorder"; } /** * The configuration for the table's menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#TableMenuConfig Read more...} */ export interface TableMenuConfig { disabled?: boolean; items: TableMenuItemConfig[]; open?: boolean; } /** * The configuration for an individual menu item within the table menu. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#TableMenuItemConfig Read more...} */ export interface TableMenuItemConfig { label: string; disabled?: boolean; icon?: string; iconClass?: string; selected?: boolean; clickFunction: TableMenuItemConfigClickFunction; hidden?: TableMenuItemConfigHiddenFunction | boolean; } export type TableMenuItemConfigClickFunction = (event: MouseEvent | KeyboardEvent) => void; export type TableMenuItemConfigHiddenFunction = () => boolean; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTable.html#VisibleElements Read more...} */ export interface FeatureTableVisibleElements { columnDescriptions?: boolean; columnMenus?: boolean; columnMenuItems?: VisibleElementsColumnMenuItems; header?: boolean; layerDropdown?: boolean; layerDropdownIcons?: boolean; menu?: boolean; menuItems?: VisibleElementsMenuItems; progress?: boolean; selectionColumn?: boolean; tooltips?: boolean; } export interface VisibleElementsColumnMenuItems { sortAscending?: boolean; sortDescending?: boolean; } export interface VisibleElementsMenuItems { clearSelection?: boolean; deleteSelection?: boolean; exportSelectionToCSV?: boolean; refreshData?: boolean; selectedRecordsShowAllToggle?: boolean; selectedRecordsShowSelectedToggle?: boolean; toggleColumns?: boolean; zoomToSelection?: boolean; } export class FeatureTemplates extends Widget { /** * Used to disable the widget user interface. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#disabled Read more...} */ disabled: boolean; /** * Indicates whether the list of available feature {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} should scroll within its containing element. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#enableListScroll Read more...} */ enableListScroll: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#FilterFunction Function} can be defined to help filter * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#filterFunction Read more...} */ filterFunction: FilterFunction | nullish; /** * Text used to filter items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#filterText Read more...} */ filterText: string; /** * It is possible to group {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items}. * * @default "layer" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#groupBy Read more...} */ groupBy: string | GroupByFunction | nullish; /** * Indicates the heading level to use for the labels of grouped feature templates. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#headingLevel Read more...} */ headingLevel: number; /** * Icon displayed in the widget's button. * * @default "list-rectangle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#label Read more...} */ label: string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers} * to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#layers Read more...} */ layers: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | SubtypeGroupLayer | OrientedImageryLayer)[]; /** * Specifies the selection behavior of list items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#selectionMode Read more...} */ selectionMode: "single" | "none" | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#visibleElements Read more...} */ visibleElements: FeatureTemplatesVisibleElements; /** * The FeatureTemplates widget is part of the overall editing workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html Read more...} */ constructor(properties?: FeatureTemplatesProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#viewModel Read more...} */ get viewModel(): FeatureTemplatesViewModel; set viewModel(value: FeatureTemplatesViewModelProperties); /** * Selects the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template item} to use. * * @param item The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template item} to select. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#select Read more...} */ select(item: TemplateItem | nullish): void; on(name: "select", eventHandler: FeatureTemplatesSelectEventHandler): IHandle; } interface FeatureTemplatesProperties extends WidgetProperties { /** * Used to disable the widget user interface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#disabled Read more...} */ disabled?: boolean; /** * Indicates whether the list of available feature {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} should scroll within its containing element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#enableListScroll Read more...} */ enableListScroll?: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#FilterFunction Function} can be defined to help filter * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#filterFunction Read more...} */ filterFunction?: FilterFunction | nullish; /** * Text used to filter items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#filterText Read more...} */ filterText?: string; /** * It is possible to group {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#groupBy Read more...} */ groupBy?: string | GroupByFunction | nullish; /** * Indicates the heading level to use for the labels of grouped feature templates. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#label Read more...} */ label?: string; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers} * to display within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#layers Read more...} */ layers?: (FeatureLayer | GeoJSONLayer | SceneLayer | SubtypeSublayer | SubtypeGroupLayer | OrientedImageryLayer)[]; /** * Specifies the selection behavior of list items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#selectionMode Read more...} */ selectionMode?: "single" | "none" | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#viewModel Read more...} */ viewModel?: FeatureTemplatesViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#visibleElements Read more...} */ visibleElements?: FeatureTemplatesVisibleElements; } export interface FeatureTemplatesViewModel extends Accessor, Evented { } export class FeatureTemplatesViewModel { /** * Used to disable the associated user interface. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#disabled Read more...} */ disabled: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#FilterFunction Function} can be defined to help filter * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#filterFunction Read more...} */ filterFunction: FilterFunction | nullish; /** * It is possible to group {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items}. * * @default "layer" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#groupBy Read more...} */ groupBy: string | GroupByFunction | nullish; /** * The template items or grouped template items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#items Read more...} */ readonly items: (TemplateItem | TemplateItemGroup)[]; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers} * that are associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#layers Read more...} */ layers: (FeatureLayer | GeoJSONLayer | SceneLayer | OrientedImageryLayer | SubtypeSublayer | SubtypeGroupLayer)[]; /** * The widget's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#state Read more...} */ readonly state: "ready" | "loading" | "disabled"; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html Read more...} */ constructor(properties?: FeatureTemplatesViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * This method updates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} with the provided filter. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#refresh Read more...} */ refresh(): void; /** * Selects the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template item} to use. * * @param item The geoscene/widgets/FeatureTemplates/TemplateItem template item to select. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#select Read more...} */ select(item: TemplateItem | nullish): void; on(name: "select", eventHandler: FeatureTemplatesViewModelSelectEventHandler): IHandle; } interface FeatureTemplatesViewModelProperties { /** * Used to disable the associated user interface. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#disabled Read more...} */ disabled?: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#FilterFunction Function} can be defined to help filter * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items} within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#filterFunction Read more...} */ filterFunction?: FilterFunction | nullish; /** * It is possible to group {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html template items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#groupBy Read more...} */ groupBy?: string | GroupByFunction | nullish; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayers} * that are associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#layers Read more...} */ layers?: (FeatureLayer | GeoJSONLayer | SceneLayer | OrientedImageryLayer | SubtypeSublayer | SubtypeGroupLayer)[]; } export interface FeatureTemplatesViewModelSelectEvent { item: TemplateItem; template: FeatureTemplate; } export class TemplateItem extends Accessor { /** * The description that is displayed for the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#description Read more...} */ description: string | nullish; /** * The label that is displayed for the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#label Read more...} */ label: string | nullish; /** * The layer associated with the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#layer Read more...} */ layer: FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html FeatureTemplate} for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#template Read more...} */ template: FeatureTemplate | SharedTemplateMetadata; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#thumbnail Read more...} */ thumbnail: HTMLElement | nullish; /** * The item displayed within the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html Read more...} */ constructor(properties?: TemplateItemProperties); /** * Creates a deep clone of the template item object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#clone Read more...} */ clone(): TemplateItem; } interface TemplateItemProperties { /** * The description that is displayed for the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#description Read more...} */ description?: string | nullish; /** * The label that is displayed for the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#label Read more...} */ label?: string | nullish; /** * The layer associated with the template item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#layer Read more...} */ layer?: FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer; /** * The associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-support-FeatureTemplate.html FeatureTemplate} for the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#template Read more...} */ template?: FeatureTemplate | SharedTemplateMetadata; /** * An object used to create a thumbnail image that represents a feature type in the feature template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html#thumbnail Read more...} */ thumbnail?: HTMLElement | nullish; } export interface TemplateItemGroup extends Accessor, Identifiable { } export class TemplateItemGroup { /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html TemplateItems} grouped * to display in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItemGroup.html#items Read more...} */ readonly items: TemplateItem[]; /** * The label displayed in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} widget * indicating the grouped {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItem.html TemplateItems}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItemGroup.html#label Read more...} */ readonly label: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItemGroup.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * This is a read-only support class that represents a group of items displayed within * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html FeatureTemplates} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItemGroup.html Read more...} */ constructor(properties?: TemplateItemGroupProperties); /** * Notifies the tracking system that `filterFunction` has changed and that * `items` may therefore need to be recomputed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates-TemplateItemGroup.html#reapplyFilter Read more...} */ reapplyFilter(): void; } interface TemplateItemGroupProperties extends IdentifiableProperties { } export type FilterFunction = (filterName: FilterFunctionFilterName) => boolean; export type GroupByFunction = (grouping: GroupByFunctionGrouping) => string | any; export interface FeatureTemplatesSelectEvent { item: TemplateItem; template: FeatureTemplate; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FeatureTemplates.html#VisibleElements Read more...} */ export interface FeatureTemplatesVisibleElements { filter?: boolean; } export interface FilterFunctionFilterName { label: string | nullish; } export interface GroupByFunctionGrouping { layer: FeatureLayer; template: FeatureTemplate; } export class FloorFilter extends Widget { /** * The currently selected facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#facility Read more...} */ facility: string | nullish; /** * Indicates the heading level to use for the headings separating floors in buildings. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#headingLevel Read more...} */ headingLevel: number; /** * Icon displayed in the widget's button. * * @default "floor-plan" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#icon Read more...} */ icon: string; /** * The currently selected floor level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#level Read more...} */ level: string | nullish; /** * Determines if the widget is expanded or collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#longNames Read more...} */ longNames: boolean; /** * The currently selected site. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#site Read more...} */ site: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The FloorFilter widget simplifies visualization of GIS data for a specific floor of a * building in your application. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html Read more...} */ constructor(properties?: FloorFilterProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#viewModel Read more...} */ get viewModel(): FloorFilterViewModel; set viewModel(value: FloorFilterViewModelProperties); /** * Updates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html#FloorFilter floorFilter} widget definition in the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * @param webmap The webmap to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#updateWebDocument Read more...} */ updateWebDocument(webmap: WebMap): void; } interface FloorFilterProperties extends WidgetProperties { /** * The currently selected facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#facility Read more...} */ facility?: string | nullish; /** * Indicates the heading level to use for the headings separating floors in buildings. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#icon Read more...} */ icon?: string; /** * The currently selected floor level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#level Read more...} */ level?: string | nullish; /** * Determines if the widget is expanded or collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#longNames Read more...} */ longNames?: boolean; /** * The currently selected site. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#site Read more...} */ site?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html#viewModel Read more...} */ viewModel?: FloorFilterViewModelProperties; } export interface FloorFilterViewModel extends Accessor, GoTo { } export class FloorFilterViewModel { /** * The currently selected facility. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#facility Read more...} */ facility: string | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * The currently selected level. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#level Read more...} */ level: string | nullish; /** * Determines if the widget is expanded or collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#longNames Read more...} */ longNames: boolean; /** * The currently selected site. * * @default undefined * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#site Read more...} */ site: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter.html FloorFilter} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-floor-filter/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html Read more...} */ constructor(properties?: FloorFilterViewModelProperties); } interface FloorFilterViewModelProperties extends GoToProperties { /** * The currently selected facility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#facility Read more...} */ facility?: string | nullish; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The currently selected level. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#level Read more...} */ level?: string | nullish; /** * Determines if the widget is expanded or collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#longNames Read more...} */ longNames?: boolean; /** * The currently selected site. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#site Read more...} */ site?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-FloorFilter-FloorFilterViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class Fullscreen extends Widget { /** * The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} to present in fullscreen mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#element Read more...} */ element: HTMLElement | nullish; /** * Icon displayed in the widget's button. * * @default "zoom-out-fixed" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides a simple widget to present the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} or a user-defined {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} using the entire screen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html Read more...} */ constructor(properties?: FullscreenProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#viewModel Read more...} */ get viewModel(): FullscreenViewModel; set viewModel(value: FullscreenViewModelProperties); } interface FullscreenProperties extends WidgetProperties { /** * The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} to present in fullscreen mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#element Read more...} */ element?: HTMLElement | nullish; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html#viewModel Read more...} */ viewModel?: FullscreenViewModelProperties; } export class FullscreenViewModel extends Accessor { /** * The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} to present in fullscreen mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#element Read more...} */ element: HTMLElement | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#state Read more...} */ readonly state: "active" | "ready" | "feature-unsupported" | "disabled"; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen.html Fullscreen} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html Read more...} */ constructor(properties?: FullscreenViewModelProperties); /** * Enter fullscreen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#enter Read more...} */ enter(): void; /** * Exit fullscreen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#exit Read more...} */ exit(): void; /** * Toggle fullscreen. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#toggle Read more...} */ toggle(): void; } interface FullscreenViewModelProperties { /** * The {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} to present in fullscreen mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#element Read more...} */ element?: HTMLElement | nullish; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Fullscreen-FullscreenViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class Histogram extends Widget { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#average Read more...} */ average: number | nullish; /** * Function for styling bars representing histogram bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#barCreatedFunction Read more...} */ barCreatedFunction: BarCreatedFunction | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#bins Read more...} */ bins: HistogramBin[] | nullish; /** * Function that fires each time a data line is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#dataLineCreatedFunction Read more...} */ dataLineCreatedFunction: DataLineCreatedFunction | nullish; /** * When set, renders lines on the histogram that indicate important or * meaningful values to the end user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#dataLines Read more...} */ dataLines: HistogramDataLines[] | nullish; /** * Icon displayed in the widget's button. * * @default "graph-histogram" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#label Read more...} */ label: string; /** * A function used to format labels on the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#labelFormatFunction Read more...} */ labelFormatFunction: LabelFormatter | nullish; /** * Determines the orientation of the Histogram widget. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#layout Read more...} */ layout: "vertical" | "horizontal"; /** * The maximum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#max Read more...} */ max: number | nullish; /** * The minimum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#min Read more...} */ min: number | nullish; /** * The state of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * Renders a histogram to visualize the spread of a dataset based on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#bins bins} representing buckets, or sub-ranges, of * data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html Read more...} */ constructor(properties?: HistogramProperties); /** * The view model for the Histogram widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#viewModel Read more...} */ get viewModel(): HistogramViewModel; set viewModel(value: HistogramViewModelProperties); /** * A convenience function used to create a Histogram widget instance from the result of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html histogram} statistics * function. * * @param result The result of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html histogram} statistics function used to generate a histogram for a field or expression from a layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#fromHistogramResult Read more...} */ static fromHistogramResult(result: HistogramResult): Histogram; } interface HistogramProperties extends WidgetProperties { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#average Read more...} */ average?: number | nullish; /** * Function for styling bars representing histogram bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#barCreatedFunction Read more...} */ barCreatedFunction?: BarCreatedFunction | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#bins Read more...} */ bins?: HistogramBin[] | nullish; /** * Function that fires each time a data line is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#dataLineCreatedFunction Read more...} */ dataLineCreatedFunction?: DataLineCreatedFunction | nullish; /** * When set, renders lines on the histogram that indicate important or * meaningful values to the end user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#dataLines Read more...} */ dataLines?: HistogramDataLines[] | nullish; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#label Read more...} */ label?: string; /** * A function used to format labels on the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#labelFormatFunction Read more...} */ labelFormatFunction?: LabelFormatter | nullish; /** * Determines the orientation of the Histogram widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#layout Read more...} */ layout?: "vertical" | "horizontal"; /** * The maximum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#max Read more...} */ max?: number | nullish; /** * The minimum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#min Read more...} */ min?: number | nullish; /** * The view model for the Histogram widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#viewModel Read more...} */ viewModel?: HistogramViewModelProperties; } export class HistogramViewModel extends Accessor { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#average Read more...} */ average: number | nullish; /** * The range of values for the histogram calculated from the bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#binRange Read more...} */ readonly binRange: number; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#bins Read more...} */ bins: HistogramBin[] | nullish; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction: LabelFormatter | nullish; /** * The maximum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#max Read more...} */ max: number | nullish; /** * The minimum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#min Read more...} */ min: number | nullish; /** * The range of values for the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#range Read more...} */ readonly range: number; /** * The current state of the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html Histogram} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html Read more...} */ constructor(properties?: HistogramViewModelProperties); } interface HistogramViewModelProperties { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#average Read more...} */ average?: number | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#bins Read more...} */ bins?: HistogramBin[] | nullish; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction?: LabelFormatter | nullish; /** * The maximum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#max Read more...} */ max?: number | nullish; /** * The minimum value or bound of the entire histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram-HistogramViewModel.html#min Read more...} */ min?: number | nullish; } export type BarCreatedFunction = (index: number, element: any) => void; /** * Represents the bin of a histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html#Bin Read more...} */ export interface Bin { count: number; minValue: number; maxValue: number; } export type DataLineCreatedFunction = (lineElement: any, labelElement?: any, index?: number) => void; export interface HistogramDataLines { value: number; label?: string | number | nullish; } export type LabelFormatter = (value: number, type?: string, index?: number) => string; export class HistogramRangeSlider extends Widget { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#average Read more...} */ average: number | nullish; /** * Function for styling bars representing histogram bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#barCreatedFunction Read more...} */ barCreatedFunction: BarCreatedFunction | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#bins Read more...} */ bins: HistogramBin[] | nullish; /** * Function that fires each time a data line is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#dataLineCreatedFunction Read more...} */ dataLineCreatedFunction: DataLineCreatedFunction | nullish; /** * When set, renders lines on the histogram that indicate important or * meaningful values to the end user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#dataLines Read more...} */ dataLines: HistogramRangeSliderDataLines[] | nullish; /** * Icon displayed in the widget's button. * * @default "arrow-double-horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#label Read more...} */ label: string; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#labelFormatFunction Read more...} */ labelFormatFunction: SliderLabelFormatter; /** * The maximum value or upper bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#max Read more...} */ max: number | nullish; /** * The minimum value or lower bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#min Read more...} */ min: number | nullish; /** * Defines how slider thumb values should be rounded. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#precision Read more...} */ precision: number; /** * Indicates how the histogram bins should be rendered as the user slides the thumbs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType Read more...} */ rangeType: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#standardDeviation Read more...} */ standardDeviation: number | nullish; /** * Indicates the number of standard deviation lines to render on the histogram * from the [average]. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#standardDeviationCount Read more...} */ standardDeviationCount: number; /** * An array of either one or two numbers representing thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#values Read more...} */ values: number[] | nullish; /** * A slider widget that can be used for filtering data or gathering * numeric input from a user for a range of data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html Read more...} */ constructor(properties?: HistogramRangeSliderProperties); /** * Sets the color of the histogram bars that are excluded based on the specified * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType rangeType}. * * @default "#d7e5f0" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#excludedBarColor Read more...} */ get excludedBarColor(): Color; set excludedBarColor(value: ColorProperties); /** * Sets the color of the histogram bars that are included in the specified * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType rangeType}. * * @default "#599dd4" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#includedBarColor Read more...} */ get includedBarColor(): Color; set includedBarColor(value: ColorProperties); /** * The view model for the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#viewModel Read more...} */ get viewModel(): HistogramRangeSliderViewModel; set viewModel(value: HistogramRangeSliderViewModelProperties); /** * Generates a SQL where clause based on a given field and the slider's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType rangeType}. * * @param field Name of the field used in the where clause. This field should correspond to the data used to generate the histogram associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#generateWhereClause Read more...} */ generateWhereClause(field: string): string | nullish; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#average Read more...} */ average?: number | nullish; /** * Function for styling bars representing histogram bins. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#barCreatedFunction Read more...} */ barCreatedFunction?: BarCreatedFunction | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#bins Read more...} */ bins?: HistogramBin[] | nullish; /** * Function that fires each time a data line is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#dataLineCreatedFunction Read more...} */ dataLineCreatedFunction?: DataLineCreatedFunction | nullish; /** * When set, renders lines on the histogram that indicate important or * meaningful values to the end user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#dataLines Read more...} */ dataLines?: HistogramRangeSliderDataLines[] | nullish; /** * Sets the color of the histogram bars that are excluded based on the specified * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType rangeType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#excludedBarColor Read more...} */ excludedBarColor?: ColorProperties; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#icon Read more...} */ icon?: string; /** * Sets the color of the histogram bars that are included in the specified * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType rangeType}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#includedBarColor Read more...} */ includedBarColor?: ColorProperties; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#label Read more...} */ label?: string; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#labelFormatFunction Read more...} */ labelFormatFunction?: SliderLabelFormatter; /** * The maximum value or upper bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#max Read more...} */ max?: number | nullish; /** * The minimum value or lower bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#min Read more...} */ min?: number | nullish; /** * Defines how slider thumb values should be rounded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#precision Read more...} */ precision?: number; /** * Indicates how the histogram bins should be rendered as the user slides the thumbs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#rangeType Read more...} */ rangeType?: | "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between"; /** * Indicates the standard deviation of the dataset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#standardDeviation Read more...} */ standardDeviation?: number | nullish; /** * Indicates the number of standard deviation lines to render on the histogram * from the [average]. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#standardDeviationCount Read more...} */ standardDeviationCount?: number; /** * An array of either one or two numbers representing thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#values Read more...} */ values?: number[] | nullish; /** * The view model for the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html#viewModel Read more...} */ viewModel?: HistogramRangeSliderViewModelProperties; } export class HistogramRangeSliderViewModel extends SliderViewModel { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#average Read more...} */ average: number | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#bins Read more...} */ bins: HistogramBin[] | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction SliderViewModel.labelFormatFunction}, * which is a custom function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction: SliderLabelFormatter; /** * Determines the SQL where clause generated in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause generateWhereClause()} * for filtering purposes. * * @default "equal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType Read more...} */ 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`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#standardDeviation Read more...} */ standardDeviation: number | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider.html HistogramRangeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html Read more...} */ constructor(properties?: HistogramRangeSliderViewModelProperties); /** * Generates a SQL where clause based on a given field and the slider's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType rangeType}. * * @param field Name of the field used in the where clause. This field should correspond to the data used to generate the histogram associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause Read more...} */ generateWhereClause(field: string): string | nullish; } interface HistogramRangeSliderViewModelProperties extends SliderViewModelProperties { /** * The statistical average of the data in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#average Read more...} */ average?: number | nullish; /** * An array of objects representing each bin in the histogram. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#bins Read more...} */ bins?: HistogramBin[] | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction SliderViewModel.labelFormatFunction}, * which is a custom function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction?: SliderLabelFormatter; /** * Determines the SQL where clause generated in {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#generateWhereClause generateWhereClause()} * for filtering purposes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#rangeType Read more...} */ 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`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#standardDeviation Read more...} */ standardDeviation?: number | nullish; } export interface HistogramRangeSliderDataLines { value: number; label?: string | number | nullish; } 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 { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Icon displayed in the widget's button. * * @default "home" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#label Read more...} */ label: string; /** * Overwrite localized strings for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#uiStrings Read more...} */ uiStrings: any | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides a simple widget that switches the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} to its * initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} or a previously defined {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewpoint viewpoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html Read more...} */ constructor(properties?: HomeProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewModel Read more...} */ get viewModel(): HomeViewModel; set viewModel(value: HomeViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint}, or point of view, to zoom to when * going home. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewpoint Read more...} */ get viewpoint(): Viewpoint | nullish; set viewpoint(value: ViewpointProperties | nullish); /** * This function provides the ability to interrupt and cancel the process * of navigating the view back to the view's initial extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#cancelGo Read more...} */ cancelGo(): void; /** * Animates the view to the initial Viewpoint of the view or the * value of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewpoint viewpoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#go Read more...} */ go(): void; on(name: "go", eventHandler: HomeGoEventHandler): IHandle; } interface HomeProperties extends WidgetProperties, GoToProperties { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#label Read more...} */ label?: string; /** * Overwrite localized strings for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#uiStrings Read more...} */ uiStrings?: any | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewModel Read more...} */ viewModel?: HomeViewModelProperties; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint}, or point of view, to zoom to when * going home. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties | nullish; } export interface HomeViewModel extends Accessor, Evented, GoTo { } export class HomeViewModel { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * The current state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "going-home"; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-home/ Home} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home.html Home} widget that * animates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} to its * initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} or a previously defined {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#viewpoint viewpoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html Read more...} */ constructor(properties?: HomeViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint}, or point of view, to zoom to when * going home. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#viewpoint Read more...} */ get viewpoint(): Viewpoint | nullish; set viewpoint(value: ViewpointProperties | nullish); /** * This function provides the ability to interrupt and cancel the process * of navigating the view back to the view's initial extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#cancelGo Read more...} */ cancelGo(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Animates the view to the initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} of the view or the * value of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#viewpoint viewpoint}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#go Read more...} */ go(): void; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; on(name: "go", eventHandler: HomeViewModelGoEventHandler): IHandle; } interface HomeViewModelProperties extends GoToProperties { /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint}, or point of view, to zoom to when * going home. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Home-HomeViewModel.html#viewpoint Read more...} */ viewpoint?: ViewpointProperties | nullish; } export interface HomeViewModelGoEvent { } export interface HomeGoEvent { } export class LayerList extends Widget { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-CatalogLayerList.html CatalogLayerList} widget instance that displays a catalog layer's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html#dynamicGroupLayer dynamic group layer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#catalogLayerList Read more...} */ readonly catalogLayerList: CatalogLayerList | nullish; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} specific properties. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#catalogOptions Read more...} */ catalogOptions: LayerListCatalogOptions | nullish; /** * Indicates whether the widget is collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#collapsed Read more...} */ collapsed: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#dragEnabled Read more...} */ dragEnabled: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterPlaceholder Read more...} */ filterPlaceholder: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterPredicate Read more...} */ filterPredicate: LayerListFilterPredicate | nullish; /** * The value of the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterText Read more...} */ filterText: string; /** * Indicates the heading level to use for the heading of the widget. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "layers" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#icon Read more...} */ icon: string; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer} specific properties. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#knowledgeGraphOptions Read more...} */ knowledgeGraphOptions: LayerListKnowledgeGraphOptions | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#label Read more...} */ label: string; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: LayerListListItemCreatedHandler | nullish; /** * The minimum number of list items required to enable drag and drop reordering with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#dragEnabled dragEnabled}. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#minDragEnabledItems Read more...} */ minDragEnabledItems: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#minFilterItems Read more...} */ minFilterItems: number; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that are opened * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#catalogLayerList catalogLayerList} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#tableList tableList} flow item. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#openedLayers Read more...} */ readonly openedLayers: Collection; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing operational layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#operationalItems Read more...} */ readonly operationalItems: Collection; /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing operational layers * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#selectedItems Read more...} */ selectedItems: Collection; /** * Specifies the selection mode. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#selectionMode Read more...} */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList} widget instance that displays the tables associated with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#tableList Read more...} */ readonly tableList: TableList | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Determines the icons used to indicate visibility. * * @default "default" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibilityAppearance Read more...} */ visibilityAppearance: "default" | "checkbox"; /** * The LayerList widget provides a way to display a list of layers, and switch on/off their visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html Read more...} */ constructor(properties?: LayerListProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#viewModel Read more...} */ get viewModel(): LayerListViewModel; set viewModel(value: LayerListViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements Read more...} */ get visibleElements(): LayerListVisibleElements; set visibleElements(value: LayerListVisibleElementsProperties); /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#triggerAction Read more...} */ triggerAction(action: ActionButton | ActionToggle, item: ListItem): void; on(name: "trigger-action", eventHandler: LayerListTriggerActionEventHandler): IHandle; } interface LayerListProperties extends WidgetProperties { /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CatalogLayer.html CatalogLayer} specific properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#catalogOptions Read more...} */ catalogOptions?: LayerListCatalogOptions | nullish; /** * Indicates whether the widget is collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#collapsed Read more...} */ collapsed?: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#dragEnabled Read more...} */ dragEnabled?: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterPlaceholder Read more...} */ filterPlaceholder?: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html list items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterPredicate Read more...} */ filterPredicate?: LayerListFilterPredicate | nullish; /** * The value of the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#filterText Read more...} */ filterText?: string; /** * Indicates the heading level to use for the heading of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#icon Read more...} */ icon?: string; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-KnowledgeGraphLayer.html KnowledgeGraphLayer} specific properties. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#knowledgeGraphOptions Read more...} */ knowledgeGraphOptions?: LayerListKnowledgeGraphOptions | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#label Read more...} */ label?: string; /** * A function that executes each time a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: LayerListListItemCreatedHandler | nullish; /** * The minimum number of list items required to enable drag and drop reordering with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#dragEnabled dragEnabled}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#minDragEnabledItems Read more...} */ minDragEnabledItems?: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#minFilterItems Read more...} */ minFilterItems?: number; /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing operational layers * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#selectedItems Read more...} */ selectedItems?: Collection; /** * Specifies the selection mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#selectionMode Read more...} */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#viewModel Read more...} */ viewModel?: LayerListViewModelProperties; /** * Determines the icons used to indicate visibility. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibilityAppearance Read more...} */ visibilityAppearance?: "default" | "checkbox"; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#visibleElements Read more...} */ visibleElements?: LayerListVisibleElementsProperties; } export interface LayerListViewModel extends Accessor, Evented { } export class LayerListViewModel { /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled: boolean; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: LayerListListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}s representing operational layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#operationalItems Read more...} */ readonly operationalItems: Collection; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#state Read more...} */ readonly state: "loading" | "ready" | "disabled"; /** * The view from which the widget will operate. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-layer-list/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html Read more...} */ constructor(properties?: LayerListViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Moves a list item from one position to another in the LayerList widget. * * @param targetItem The list item (or layer) to move. * @param fromParentItem If the `targetItem` is a child of a parent list item and you want to move it out of the parentItem, then use this parameter to indicate the parent item to move from. * @param toParentItem The parent list item to move the `targetItem` to if moving it as a child to another parent item. * @param newIndex The new index to move the `targetItem` to. If moving the item as a child to a parent item, then specify the index of the item within that parent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#moveListItem Read more...} */ moveListItem(targetItem: ListItem | nullish, fromParentItem: ListItem | nullish, toParentItem: ListItem | nullish, newIndex: number): void; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#triggerAction Read more...} */ 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled?: boolean; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: LayerListListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#listModeDisabled Read more...} */ listModeDisabled?: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#actionsOpen Read more...} */ actionsOpen: boolean; /** * Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#childrenSortable Read more...} */ childrenSortable: boolean; /** * Only valid when the list item represents a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-StreamLayer.html StreamLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#connectionStatus Read more...} */ readonly connectionStatus: "connected" | "disconnected" | "paused" | nullish; /** * The Error object returned if an error occurred. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#error Read more...} */ readonly error: Error | nullish; /** * When `true`, hides the layer from the LayerList instance. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#hidden Read more...} */ hidden: boolean; /** * Whether the layer is unsupported by the view. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#incompatible Read more...} */ readonly incompatible: boolean; /** * The layer associated with the triggered action. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#layer Read more...} */ layer: Layer | Sublayer | SubtypeSublayer | SubtypeGroupLayer | nullish; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-layers-LayerView.html LayerView} displaying data for the * associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#layer layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#layerView Read more...} */ readonly layerView: LayerView | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the child layers in the list item. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * Whether the layer is open in the LayerList. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#open Read more...} */ open: boolean; /** * The parent of this item. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#parent Read more...} */ parent: ListItem | nullish; /** * Value is `true` when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#layer layer} is being published. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#publishing Read more...} */ readonly publishing: boolean; /** * Indicates if the list item (or layer in the map) can be sorted or moved/reordered. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#sortable Read more...} */ sortable: boolean; /** * The title of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#title Read more...} */ title: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Value is `true` when the layer is updating; for example, if it is in the process of fetching data. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#updating Read more...} */ readonly updating: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Indicates how to manage the visibility of the children layers. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#visibilityMode Read more...} */ readonly visibilityMode: string; /** * Indicates if the ListItem is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#visible Read more...} */ visible: boolean; /** * Whether the layer is visible at the current scale or not. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#visibleAtCurrentScale Read more...} */ readonly visibleAtCurrentScale: boolean; /** * Whether the layer is visible at the current time extent or not. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#visibleAtCurrentTimeExtent Read more...} */ readonly visibleAtCurrentTimeExtent: boolean; /** * The ListItem class represents one of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html#operationalItems operationalItems} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-LayerListViewModel.html LayerListViewModel}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html Read more...} */ constructor(properties?: ListItemProperties); /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#actionsSections Read more...} */ get actionsSections(): Collection>; set actionsSections(value: | 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#children Read more...} */ get children(): Collection; set children(value: CollectionProperties); /** * Allows you to display custom content for each ListItem * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#panel Read more...} */ get panel(): ListItemPanel; set panel(value: ListItemPanelProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#clone Read more...} */ clone(): ListItem; } interface ListItemProperties extends IdentifiableProperties { /** * Whether the actions panel is open in the LayerList. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#actionsOpen Read more...} */ actionsOpen?: boolean; /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#actionsSections Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#children Read more...} */ children?: CollectionProperties; /** * Indicates if the children of a list item (or sublayers in a GroupLayer) can be sorted or moved/reordered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#childrenSortable Read more...} */ childrenSortable?: boolean; /** * When `true`, hides the layer from the LayerList instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#hidden Read more...} */ hidden?: boolean; /** * The layer associated with the triggered action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#layer Read more...} */ layer?: Layer | Sublayer | SubtypeSublayer | SubtypeGroupLayer | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the child layers in the list item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#listModeDisabled Read more...} */ listModeDisabled?: boolean; /** * Whether the layer is open in the LayerList. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#open Read more...} */ open?: boolean; /** * Allows you to display custom content for each ListItem * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#panel Read more...} */ panel?: ListItemPanelProperties; /** * The parent of this item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#parent Read more...} */ parent?: ListItem | nullish; /** * Indicates if the list item (or layer in the map) can be sorted or moved/reordered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#sortable Read more...} */ sortable?: boolean; /** * The title of the layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#title Read more...} */ title?: string; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * Indicates if the ListItem is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html#visible Read more...} */ visible?: boolean; } export interface ListItemPanel extends Widget, Identifiable { } export class ListItemPanel { /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#content Read more...} */ content: LayerListItemPanelContent | LayerListItemPanelContent[] | nullish; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#disabled Read more...} */ disabled: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://doc.geoscene.cn/calcite-design-system/components/flow-item/). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#flowEnabled Read more...} */ flowEnabled: boolean; /** * The URL or data URI of an image used to represent the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#image Read more...} */ image: string | nullish; /** * The panel's parent ListItem that represents a layer in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#listItem Read more...} */ listItem: ListItem | nullish; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#open Read more...} */ open: boolean; /** * The title of the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#title Read more...} */ title: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * This class allows you to display custom content for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItem.html ListItem} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html LayerList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html Read more...} */ constructor(properties?: ListItemPanelProperties); } interface ListItemPanelProperties extends WidgetProperties, IdentifiableProperties { /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#content Read more...} */ content?: LayerListItemPanelContent | LayerListItemPanelContent[] | nullish; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#disabled Read more...} */ disabled?: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://doc.geoscene.cn/calcite-design-system/components/flow-item/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#flowEnabled Read more...} */ flowEnabled?: boolean; /** * The URL or data URI of an image used to represent the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#image Read more...} */ image?: string | nullish; /** * The panel's parent ListItem that represents a layer in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#listItem Read more...} */ listItem?: ListItem | nullish; /** * Indicates if the panel's content is open and visible to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#open Read more...} */ open?: boolean; /** * The title of the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#title Read more...} */ title?: string; } /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList-ListItemPanel.html#LayerListItemPanelContent Read more...} */ export type LayerListItemPanelContent = Widget | HTMLElement | string | "legend"; export type LayerListFilterPredicate = (item: ListItem) => void; export interface LayerListCatalogOptions { filterPlaceholder?: string; listItemCreatedFunction?: CatalogLayerListListItemCreatedHandler | nullish; minFilterItems?: number; selectionMode?: string; visibilityAppearance?: string; visibleElements?: LayerListCatalogOptionsVisibleElements; } export interface LayerListCatalogOptionsVisibleElements { errors?: boolean; filter?: boolean; statusIndicators?: boolean; temporaryLayerIndicators?: boolean; } export interface LayerListKnowledgeGraphOptions { filterPlaceholder?: string; listItemCreatedFunction?: TableListListItemCreatedHandler | nullish; minFilterItems?: number; selectionMode?: "multiple" | "none" | "single" | "single-persist"; visibleElements?: LayerListKnowledgeGraphOptionsVisibleElements; } export interface LayerListKnowledgeGraphOptionsVisibleElements { errors?: boolean; filter?: boolean; statusIndicators?: boolean; } export type LayerListListItemCreatedHandler = (event: LayerListListItemCreatedHandlerEvent) => void; export interface LayerListTriggerActionEvent { action: ActionButton | ActionToggle; item: ListItem; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#VisibleElements Read more...} */ export interface LayerListVisibleElementsProperties { catalogLayerList?: boolean; closeButton?: boolean; collapseButton?: boolean; errors?: boolean; filter?: boolean; flow?: boolean; heading?: boolean; statusIndicators?: boolean; temporaryLayerIndicators?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LayerList.html#VisibleElements Read more...} */ export interface LayerListVisibleElements extends AnonymousAccessor { catalogLayerList: boolean; closeButton: boolean; collapseButton: boolean; errors: boolean; filter: boolean; flow: boolean; heading: boolean; statusIndicators: boolean; temporaryLayerIndicators: boolean; } export interface LayerListListItemCreatedHandlerEvent { item: ListItem; } export class Legend extends Widget { /** * Indicates whether to show the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} layers in the Legend. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#basemapLegendVisible Read more...} */ basemapLegendVisible: boolean; /** * Indicates the heading level to use for the legend title. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#headingLevel Read more...} */ headingLevel: number; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView: boolean; /** * Icon which represents the widget. * * @default "legend" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#label Read more...} */ label: string; /** * Specifies a subset of the layers to display in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#layerInfos Read more...} */ layerInfos: LegendLayerInfos[]; /** * If a layer uses a unique value render, only features that satisfy the layer's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression definition expression} * will be displayed in the legend when set to true. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#respectLayerDefinitionExpression Read more...} */ respectLayerDefinitionExpression: boolean; /** * Determines whether to respect the properties of the layers in the map that * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#respectLayerVisibility Read more...} */ respectLayerVisibility: boolean; /** * Indicates the style of the legend. * * @default "classic" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#style Read more...} */ style: string | LegendStyle; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html LinkChartView}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#view Read more...} */ view: MapView | LinkChartView | SceneView | nullish; /** * The Legend widget describes the symbols used to represent layers in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Read more...} */ constructor(properties?: LegendProperties); /** * Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html ActiveLayerInfo} objects used by the legend view to * display data in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#activeLayerInfos Read more...} */ get activeLayerInfos(): Collection; set activeLayerInfos(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#viewModel Read more...} */ get viewModel(): LegendViewModel; set viewModel(value: LegendViewModelProperties); } interface LegendProperties extends WidgetProperties { /** * Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html ActiveLayerInfo} objects used by the legend view to * display data in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#activeLayerInfos Read more...} */ activeLayerInfos?: CollectionProperties; /** * Indicates whether to show the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} layers in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#basemapLegendVisible Read more...} */ basemapLegendVisible?: boolean; /** * Indicates the heading level to use for the legend title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#headingLevel Read more...} */ headingLevel?: number; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView?: boolean; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#label Read more...} */ label?: string; /** * Specifies a subset of the layers to display in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#layerInfos Read more...} */ layerInfos?: LegendLayerInfos[]; /** * If a layer uses a unique value render, only features that satisfy the layer's * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html#definitionExpression definition expression} * will be displayed in the legend when set to true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#respectLayerDefinitionExpression Read more...} */ respectLayerDefinitionExpression?: boolean; /** * Determines whether to respect the properties of the layers in the map that * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#respectLayerVisibility Read more...} */ respectLayerVisibility?: boolean; /** * Indicates the style of the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#style Read more...} */ style?: string | LegendStyle; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html LinkChartView}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#view Read more...} */ view?: MapView | LinkChartView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html#viewModel Read more...} */ viewModel?: LegendViewModelProperties; } export class LegendViewModel extends Accessor { /** * Indicates whether to show the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} layers in the Legend. * * @default filterBasemaps * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#basemapLegendVisible Read more...} */ basemapLegendVisible: boolean; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView: boolean; /** * Specifies a subset of the layers in the map to display in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#layerInfos Read more...} */ 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#respectLayerVisibility Read more...} */ respectLayerVisibility: boolean; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend.html Legend} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-legend/ component}, * which displays a label and symbol for interpreting the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer} * of each layer in a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html Read more...} */ constructor(properties?: LegendViewModelProperties); /** * Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html ActiveLayerInfo} objects used by the legend view to * display data in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#activeLayerInfos Read more...} */ get activeLayerInfos(): Collection; set activeLayerInfos(value: CollectionProperties); } interface LegendViewModelProperties { /** * Collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html ActiveLayerInfo} objects used by the legend view to * display data in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#activeLayerInfos Read more...} */ activeLayerInfos?: CollectionProperties; /** * Indicates whether to show the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Basemap.html Basemap} layers in the Legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#basemapLegendVisible Read more...} */ basemapLegendVisible?: boolean; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView?: boolean; /** * Specifies a subset of the layers in the map to display in the legend. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#layerInfos Read more...} */ layerInfos?: LegendViewModelLayerInfos[]; /** * Determines whether to respect the properties of the layers in the map that * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#respectLayerVisibility Read more...} */ respectLayerVisibility?: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-LegendViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export interface LegendViewModelLayerInfos { title: string; layer: Layer | Sublayer; } export class ActiveLayerInfo extends Accessor { /** * A collection of child activeLayerInfos. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#children Read more...} */ children: Collection; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView: boolean; /** * Indicates if the legend's display of the layer's renderer is driven by the scale of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#isScaleDriven Read more...} */ readonly isScaleDriven: boolean; /** * The layer represented by the ActiveLayerInfo object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layer Read more...} */ layer: Layer; /** * The layerView represented by the ActiveLayerInfo object's layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layerView Read more...} */ layerView: LayerView; /** * The legendElements is constructed using the layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElements Read more...} */ legendElements: LegendElement[]; /** * The opacity of the layer or parent element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#opacity Read more...} */ readonly opacity: number; /** * The ActiveLayerInfo of the parent module:geoscene/layers/support/ISublayer or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html GroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#parent Read more...} */ parent: ActiveLayerInfo | nullish; /** * Indicates if the activeLayerInfo is ready. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#ready Read more...} */ readonly 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#respectLayerVisibility Read more...} */ respectLayerVisibility: boolean; /** * The scale of the view instance in which the Legend is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#scale Read more...} */ readonly scale: number; /** * Only applies if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layer layer} is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#sublayerIds Read more...} */ sublayerIds: number[]; /** * The text string that represents the legend's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#title Read more...} */ title: string | nullish; /** * The version of the ActiveLayerInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#version Read more...} */ readonly version: number; /** * The view in which the Legend is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#view Read more...} */ view: MapView | SceneView; /** * ActiveLayerInfo is added to or removed from the collection of * activeLayerInfos as layers become visible or * invisible in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html Read more...} */ constructor(properties?: ActiveLayerInfoProperties); } interface ActiveLayerInfoProperties { /** * A collection of child activeLayerInfos. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#children Read more...} */ children?: Collection; /** * When `true`, layers will only be shown in the legend if * they are visible in the view's extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#hideLayersNotInCurrentView Read more...} */ hideLayersNotInCurrentView?: boolean; /** * The layer represented by the ActiveLayerInfo object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layer Read more...} */ layer?: Layer; /** * The layerView represented by the ActiveLayerInfo object's layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layerView Read more...} */ layerView?: LayerView; /** * The legendElements is constructed using the layer {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-Renderer.html Renderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElements Read more...} */ legendElements?: LegendElement[]; /** * The ActiveLayerInfo of the parent module:geoscene/layers/support/ISublayer or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GroupLayer.html GroupLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#parent Read more...} */ parent?: ActiveLayerInfo | nullish; /** * Determines whether to respect the properties of the layers in the map that * control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#respectLayerVisibility Read more...} */ respectLayerVisibility?: boolean; /** * Only applies if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#layer layer} is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html MapImageLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#sublayerIds Read more...} */ sublayerIds?: number[]; /** * The text string that represents the legend's title. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#title Read more...} */ title?: string | nullish; /** * The view in which the Legend is rendered. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#view Read more...} */ view?: MapView | SceneView; } /** * Describes the schema of the ClusterTitle element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#ClusterTitle Read more...} */ export interface ClusterTitle { showCount: boolean; } /** * Describes the schema of the ColorRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#ColorRampElement Read more...} */ export interface ColorRampElement { type: "color-ramp"; title?: string | RampTitle | nullish; infos: ColorRampStop[]; } /** * Describes the schema of the ColorRampStop element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#ColorRampStop Read more...} */ export interface ColorRampStop { label: string | nullish; value: number | string | nullish; color: Color; } /** * Describes the schema of the DotDensityTitle element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#DotDensityTitle Read more...} */ export interface DotDensityTitle { value: number; unit?: string | nullish; } /** * Describes the schema of the HeatmapRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampElement Read more...} */ export interface HeatmapRampElement { type: "heatmap-ramp"; title?: string | RendererTitle | nullish; infos: HeatmapRampStop[]; } /** * Describes the schema of the HeatmapRampStop element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#HeatmapRampStop Read more...} */ export interface HeatmapRampStop { label: string; ratio: number; color: Color; } /** * Properties defining the scheme of each of the ImageSymbolTableElementInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#ImageSymbolTableElementInfo Read more...} */ export interface ImageSymbolTableElementInfo { label?: string | StretchMultibandTitle | nullish; src: string; opacity?: number | nullish; width?: number | nullish; height?: number | nullish; } /** * Properties defining the scheme of each of the supported {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElements legendElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#LegendElement Read more...} */ export type LegendElement = | SymbolTableElement | ColorRampElement | StretchRampElement | OpacityRampElement | SizeRampElement | HeatmapRampElement | RelationshipRampElement | UnivariateColorSizeRampElement | PieChartRampElement; /** * Describes the schema of the OpacityRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampElement Read more...} */ export interface OpacityRampElement { type: "opacity-ramp"; title?: string | RampTitle | nullish; infos: OpacityRampStop[]; } /** * Describes the schema of the OpacityRampStop element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#OpacityRampStop Read more...} */ export interface OpacityRampStop { label: string; value: number; color: Color; } /** * Describes the schema of the UnivariateColorSizeRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#PieChartRampElement Read more...} */ export interface PieChartRampElement { type: "pie-chart-ramp"; title?: string | RendererTitle | nullish; infos: SymbolTableElementInfo[]; } /** * Describes the schema of the RampTitle element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#RampTitle Read more...} */ export interface RampTitle { field?: string | nullish; normField?: string | nullish; ratio: boolean; ratioPercent: boolean; ratioPercentTotal: boolean; } /** * Describes the schema of the RelationshipLabels element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#RelationshipLabels Read more...} */ export interface RelationshipLabels { top: string; bottom: string; left: string; right: string; } /** * Describes the schema of the RelationshipRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#RelationshipRampElement Read more...} */ export interface RelationshipRampElement { type: "relationship-ramp"; numClasses: number; focus: "HH" | "HL" | "LH" | "LL"; colors: Color[][]; labels: RelationshipLabels; rotation: number; title?: string | nullish; infos?: any[] | nullish; } /** * Describes the schema of the RendererTitle element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#RendererTitle Read more...} */ export interface RendererTitle { title?: string | nullish; field?: string | nullish; normField?: string | nullish; normByPct?: boolean | nullish; } /** * Describes the schema of the SizeRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#SizeRampElement Read more...} */ export interface SizeRampElement { type: "size-ramp"; title?: string | RampTitle | ClusterTitle | nullish; infos: SizeRampStop[]; } /** * Describes the schema of the SizeRampStop element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#SizeRampStop Read more...} */ export interface SizeRampStop { label: string; value?: any; symbol: SymbolUnion; size?: number | any | nullish; outlineSize?: number | nullish; preview?: HTMLElement | nullish; } /** * Describes the schema of the StretchMultibandTitle element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#StretchMultibandTitle Read more...} */ export interface StretchMultibandTitle { colorName: string; bandName: string; } /** * Describes the schema of the StretchRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#StretchRampElement Read more...} */ export interface StretchRampElement { type: "stretch-ramp"; title?: string | RampTitle | nullish; infos: ColorRampStop[]; } /** * Describes the schema of the SymbolTableElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElement Read more...} */ export interface SymbolTableElement { type: "symbol-table"; title?: string | RendererTitle | DotDensityTitle | nullish; legendType?: string | nullish; infos: SymbolTableElementType[]; } /** * Properties defining the scheme of the SymbolTableElementInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementInfo Read more...} */ export interface SymbolTableElementInfo { label?: string | RampTitle | nullish; value?: any; symbol: SymbolUnion; size?: number | nullish; preview?: HTMLElement | nullish; } /** * Properties defining the scheme of each SymbolTableElementType. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#SymbolTableElementType Read more...} */ export type SymbolTableElementType = ImageSymbolTableElementInfo | SymbolTableElementInfo | LegendElement; /** * Describes the schema of the UnivariateColorSizeRampElement used as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#legendElement legendElement}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Legend-support-ActiveLayerInfo.html#UnivariateColorSizeRampElement Read more...} */ export interface UnivariateColorSizeRampElement { type: "univariate-above-and-below-ramp" | "univariate-color-size-ramp"; title?: string | RampTitle | ClusterTitle | nullish; infos: (SizeRampElement | ColorRampElement)[]; } export interface LegendLayerInfos { title?: string; layer: Layer | Sublayer; sublayerIds?: number[]; } export interface LegendStyle { type: "classic" | "card"; layout?: "auto" | "side-by-side" | "stack"; } export class LineOfSight extends Widget { /** * Icon which represents the widget. * * @default "line-of-sight" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#view Read more...} */ view: SceneView | nullish; /** * The LineOfSight widget is a 3D analysis tool that allows you to perform visibility analysis * in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html Read more...} */ constructor(properties?: LineOfSightProperties); /** * The line of sight analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#analysis Read more...} */ get analysis(): LineOfSightAnalysis; set analysis(value: LineOfSightAnalysisProperties & { type: "line-of-sight" }); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#viewModel Read more...} */ get viewModel(): LineOfSightViewModel; set viewModel(value: LineOfSightViewModelProperties); } interface LineOfSightProperties extends WidgetProperties { /** * The line of sight analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#analysis Read more...} */ analysis?: LineOfSightAnalysisProperties & { type: "line-of-sight" }; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html#viewModel Read more...} */ viewModel?: LineOfSightViewModelProperties; } export class LineOfSightTarget extends Accessor { /** * The first {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html Graphic} intersected by the line of sight. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html#intersectedGraphic Read more...} */ readonly intersectedGraphic: Graphic | nullish; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location where the line of * sight first intersects the ground or 3D objects in the scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html#intersectedLocation Read more...} */ readonly intersectedLocation: Point | nullish; /** * Whether the target is visible from the observer or not. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html#visible Read more...} */ readonly visible: boolean | nullish; /** * This class represents a target point for a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html LineOfSight} analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html Read more...} */ constructor(properties?: LineOfSightTargetProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location of the target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); } interface LineOfSightTargetProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Point.html Point} representing the location of the target. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html#location Read more...} */ location?: PointProperties | nullish; } export class LineOfSightViewModel extends Accessor { /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "creating" | "created"; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#view Read more...} */ view: SceneView; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight.html LineOfSight} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-line-of-sight/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html Read more...} */ constructor(properties?: LineOfSightViewModelProperties); /** * The line of sight analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#analysis Read more...} */ get analysis(): LineOfSightAnalysis; set analysis(value: LineOfSightAnalysisProperties & { type: "line-of-sight" }); /** * The observer's viewpoint from which lines of sight will be drawn towards the targets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#observer Read more...} */ get observer(): Point | nullish; set observer(value: PointProperties | nullish); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html LineOfSightTarget} containing * the target location and the analysis results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#targets Read more...} */ get targets(): Collection; set targets(value: CollectionProperties); /** * Clears the current analysis results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#clear Read more...} */ clear(): void; /** * If stopped, this method continues the line of sight analysis and the user can add more targets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#continue Read more...} */ continue(): void; /** * Starts a new line of sight analysis. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#start Read more...} */ start(): void; /** * Stops the current line of sight analysis, keeping the results in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#stop Read more...} */ stop(): void; } interface LineOfSightViewModelProperties { /** * The line of sight analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#analysis Read more...} */ analysis?: LineOfSightAnalysisProperties & { type: "line-of-sight" }; /** * The observer's viewpoint from which lines of sight will be drawn towards the targets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#observer Read more...} */ observer?: PointProperties | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightTarget.html LineOfSightTarget} containing * the target location and the analysis results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#targets Read more...} */ targets?: CollectionProperties; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LineOfSight-LineOfSightViewModel.html#view Read more...} */ view?: SceneView; } export interface LinkChartLayoutSwitcherViewModel extends Accessor, Evented { } export class LinkChartLayoutSwitcherViewModel { /** * The current selected link chart layout. * * @default "organic-standard" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#layout Read more...} */ layout: | "organic-standard" | "organic-community" | "basic-grid" | "hierarchical-bottom-to-top" | "radial-root-centric" | "tree-left-to-right" | "geographic-organic-standard" | "chronological-mono-timeline" | "chronological-multi-timeline"; /** * Prevents extent from updating on changes to the layout. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#preventExtentUpdate Read more...} */ preventExtentUpdate: boolean; /** * The current state of the widget. * * @default "loading" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#state Read more...} */ readonly state: "loading" | "ready" | "disabled"; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#view Read more...} */ view: LinkChartView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-link-chart-layout-switcher/ Link Chart Layout Switcher component} that * switches the layout of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-LinkChartView.html LinkChartView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html Read more...} */ constructor(properties?: LinkChartLayoutSwitcherViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Switches the layout of the link chart. * * @param newLayout List of specific entities and relationships to update. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#switchLayout Read more...} */ switchLayout(newLayout: | "organic-standard" | "organic-community" | "basic-grid" | "hierarchical-bottom-to-top" | "radial-root-centric" | "tree-left-to-right" | "geographic-organic-standard" | "chronological-mono-timeline" | "chronological-multi-timeline"): Promise; on(name: "switchLayout", eventHandler: LinkChartLayoutSwitcherViewModelSwitchLayoutEventHandler): IHandle; } interface LinkChartLayoutSwitcherViewModelProperties { /** * The current selected link chart layout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#layout Read more...} */ layout?: | "organic-standard" | "organic-community" | "basic-grid" | "hierarchical-bottom-to-top" | "radial-root-centric" | "tree-left-to-right" | "geographic-organic-standard" | "chronological-mono-timeline" | "chronological-multi-timeline"; /** * Prevents extent from updating on changes to the layout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#preventExtentUpdate Read more...} */ preventExtentUpdate?: boolean; /** * The view associated with the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#view Read more...} */ view?: LinkChartView | nullish; } export interface LinkChartLayoutSwitcherViewModelSwitchLayoutEvent { } export interface Locate extends Widget, GoTo { } export class Locate { /** * The browser's Geolocation API Position options for locating. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#geolocationOptions Read more...} */ geolocationOptions: any | nullish; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#goToLocationEnabled Read more...} */ goToLocationEnabled: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Icon displayed in the widget's button. * * @default "compass" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#label Read more...} */ label: string; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} of the result graphic from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#locate locate()} method. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#popupEnabled Read more...} */ popupEnabled: 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#event-track track} event. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#scale Read more...} */ scale: number | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides a simple widget that animates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} * to the user's current location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html Read more...} */ constructor(properties?: LocateProperties); /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#graphic Read more...} */ get graphic(): Graphic; set graphic(value: GraphicProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#viewModel Read more...} */ get viewModel(): LocateViewModel; set viewModel(value: LocateViewModelProperties); /** * This function provides the ability to interrupt and cancel the process of * programmatically obtaining the location of the user's device. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#cancelLocate Read more...} */ cancelLocate(): void; /** * Animates the view to the user's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#locate Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#geolocationOptions Read more...} */ geolocationOptions?: any | nullish; /** * Indicates whether the widget should navigate the view to the position and scale of the geolocated result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#goToLocationEnabled Read more...} */ goToLocationEnabled?: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#graphic Read more...} */ graphic?: GraphicProperties; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#label Read more...} */ label?: string; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} of the result graphic from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#locate locate()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#popupEnabled Read more...} */ popupEnabled?: 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#event-track track} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#scale Read more...} */ scale?: number | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html#viewModel Read more...} */ viewModel?: LocateViewModelProperties; } export interface LocateViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { } export class LocateViewModel { /** * Error that caused the last {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#event:locate-error locate-error} event to fire. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#error Read more...} */ error: any | Error | nullish; /** * An object used for setting optional position parameters. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#geolocationOptions Read more...} */ declare geolocationOptions: GeolocationPositioning["geolocationOptions"]; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#goToLocationEnabled Read more...} */ declare goToLocationEnabled: GeolocationPositioning["goToLocationEnabled"]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} of the result graphic from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#locate locate()} method. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated * result, after a location is returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#event-track track} event. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#scale Read more...} */ declare scale: GeolocationPositioning["scale"]; /** * The current state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "locating" | "feature-unsupported" | "error"; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#view Read more...} */ declare view: GeolocationPositioning["view"]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-locate/ Locate} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate.html Locate} widget, which * animates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} * to the user's current location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html Read more...} */ constructor(properties?: LocateViewModelProperties); /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#graphic Read more...} */ get graphic(): Graphic; set graphic(value: GraphicProperties); /** * This function provides the ability to interrupt and cancel the process of * programmatically obtaining the location of the user's device. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#cancelLocate Read more...} */ cancelLocate(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Animates the view to the user's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#locate Read more...} */ locate(): Promise; on(name: "locate", eventHandler: LocateViewModelLocateEventHandler): IHandle; on(name: "locate-error", eventHandler: LocateViewModelLocateErrorEventHandler): IHandle; } interface LocateViewModelProperties extends GeolocationPositioningProperties, GoToProperties { /** * Error that caused the last {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#event:locate-error locate-error} event to fire. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#error Read more...} */ error?: any | Error | nullish; /** * An object used for setting optional position parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#geolocationOptions Read more...} */ geolocationOptions?: GeolocationPositioningProperties["geolocationOptions"]; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#goToLocationEnabled Read more...} */ goToLocationEnabled?: GeolocationPositioningProperties["goToLocationEnabled"]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#graphic Read more...} */ graphic?: GraphicProperties; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} of the result graphic from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#locate locate()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated * result, after a location is returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#event-track track} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#scale Read more...} */ scale?: GeolocationPositioningProperties["scale"]; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Locate-LocateViewModel.html#view Read more...} */ view?: GeolocationPositioningProperties["view"]; } export interface LocateViewModelLocateErrorEvent { error: any | Error; } export interface LocateViewModelLocateEvent { position: any; } export interface LocateLocateErrorEvent { error: Error; } export interface LocateLocateEvent { position: any; } export class Measurement extends Widget { /** * Specifies the current measurement tool to display. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#activeTool Read more...} */ activeTool: "area" | "distance" | "direct-line" | nullish; /** * The measurement widget that is currently being used. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#activeWidget Read more...} */ readonly activeWidget: | AreaMeasurement2D | AreaMeasurement3D | DirectLineMeasurement3D | DistanceMeasurement2D | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#areaUnit Read more...} */ areaUnit: SystemOrAreaUnit; /** * Icon which represents the widget. * * @default "measure" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#label Read more...} */ label: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#linearUnit Read more...} */ linearUnit: SystemOrLengthUnit; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Measurement widget groups and manages multiple measurement tools and allows you to easily switch between them using * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#activeTool activeTool} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html Read more...} */ constructor(properties?: MeasurementProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#viewModel Read more...} */ get viewModel(): MeasurementViewModel; set viewModel(value: MeasurementViewModelProperties); /** * Removes all measurement widgets and associated graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#clear Read more...} */ clear(): void; /** * Starts a new measurement for the active measurement widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#startMeasurement Read more...} */ startMeasurement(): void; } interface MeasurementProperties extends WidgetProperties { /** * Specifies the current measurement tool to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#activeTool Read more...} */ activeTool?: "area" | "distance" | "direct-line" | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#areaUnit Read more...} */ areaUnit?: SystemOrAreaUnit; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#label Read more...} */ label?: string; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#linearUnit Read more...} */ linearUnit?: SystemOrLengthUnit; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html#viewModel Read more...} */ viewModel?: MeasurementViewModelProperties; } export class MeasurementViewModel extends Accessor { /** * Specifies the current measurement tool to display. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#activeTool Read more...} */ activeTool: "area" | "distance" | "direct-line" | nullish; /** * View model of the active measurement widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#activeViewModel Read more...} */ readonly activeViewModel: | AreaMeasurement2DViewModel | AreaMeasurement3DViewModel | DirectLineMeasurement3DViewModel | DistanceMeasurement2DViewModel | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#areaUnit Read more...} */ areaUnit: SystemOrAreaUnit; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#linearUnit Read more...} */ linearUnit: SystemOrLengthUnit; /** * The ViewModel's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "measuring" | "measured"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement.html Measurement} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html Read more...} */ constructor(properties?: MeasurementViewModelProperties); } interface MeasurementViewModelProperties { /** * Specifies the current measurement tool to display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#activeTool Read more...} */ activeTool?: "area" | "distance" | "direct-line" | nullish; /** * Unit system (imperial, metric) or specific unit used for displaying the area values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#areaUnit Read more...} */ areaUnit?: SystemOrAreaUnit; /** * Unit system (imperial, metric) or specific unit used for displaying the distance values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#linearUnit Read more...} */ linearUnit?: SystemOrLengthUnit; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Measurement-MeasurementViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export class NavigationToggle extends Widget { /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#label Read more...} */ label: string; /** * Sets the layout of the widget to either `horizontal` or `vertical`. * * @default "vertical" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#layout Read more...} */ layout: "vertical" | "horizontal"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#view Read more...} */ view: SceneView | nullish; /** * Provides two simple buttons for toggling the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode navigation mode} * of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html Read more...} */ constructor(properties?: NavigationToggleProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#viewModel Read more...} */ get viewModel(): NavigationToggleViewModel; set viewModel(value: NavigationToggleViewModelProperties); /** * Toggles the navigation mode of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#view view} from `pan` to `rotate` or * vice versa. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#toggle Read more...} */ toggle(): void; } interface NavigationToggleProperties extends WidgetProperties { /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#label Read more...} */ label?: string; /** * Sets the layout of the widget to either `horizontal` or `vertical`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#layout Read more...} */ layout?: "vertical" | "horizontal"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html#viewModel Read more...} */ viewModel?: NavigationToggleViewModelProperties; } export class NavigationToggleViewModel extends Accessor { /** * The navigation mode of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#view view}. * * @default "pan" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode Read more...} */ navigationMode: "pan" | "rotate"; /** * The state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle.html NavigationToggle} widget, which provides two simple buttons for * toggling the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode navigation mode} of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html Read more...} */ constructor(properties?: NavigationToggleViewModelProperties); /** * Toggles the navigation mode of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#view view} from `pan` to `rotate` or * vice versa. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#toggle Read more...} */ toggle(): void; } interface NavigationToggleViewModelProperties { /** * The navigation mode of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#view view}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#navigationMode Read more...} */ navigationMode?: "pan" | "rotate"; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-NavigationToggle-NavigationToggleViewModel.html#view Read more...} */ view?: SceneView | nullish; } export class OrientedImageryViewer extends Widget { /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#currentCoverageVisible Read more...} */ currentCoverageVisible: boolean; /** * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#dataCaptureEnabled Read more...} */ dataCaptureEnabled: boolean; /** * When `false`, the view click interaction is enabled for the oriented imagery viewer widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#disabled Read more...} */ disabled: boolean; /** * Indicates if the image gallery functionality is available in the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#galleryOpened Read more...} */ galleryOpened: boolean; /** * Icon displayed in the widget's button. * * @default "oriented-imagery-widget" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#icon Read more...} */ icon: string; /** * Indicates if the image enhancement tool is active. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#imageEnhancementToolActive Read more...} */ imageEnhancementToolActive: boolean; /** * When `true`, the image gallery functionality is available in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#imageGalleryEnabled Read more...} */ readonly imageGalleryEnabled: boolean; /** * Indicates whether the image overlays tab in the oriented imagery viewer is open. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#imageOverlaysOpened Read more...} */ imageOverlaysOpened: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible Read more...} */ isAdditionalCoverageVisible: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible Read more...} */ isAdditionalPointSourcesVisible: boolean; /** * Specifies the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html OrientedImageryLayer} to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#layer Read more...} */ layer: OrientedImageryLayer | nullish; /** * Indicates if the map-image location tool is available in the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#mapImageConversionToolState Read more...} */ mapImageConversionToolState: boolean; /** * When `true`, the navigation tool is available in the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#navigationToolActive Read more...} */ navigationToolActive: boolean; /** * This property provides the location of an image pixel in Map coordinates when using map-image conversion tool. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#referencePoint Read more...} */ readonly referencePoint: Point | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The oriented imagery viewer widget allows the user to explore and use their oriented images. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html Read more...} */ constructor(properties?: OrientedImageryViewerProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#viewModel Read more...} */ get viewModel(): OrientedImageryViewerViewModel; set viewModel(value: OrientedImageryViewerViewModelProperties); } interface OrientedImageryViewerProperties extends WidgetProperties { /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#currentCoverageVisible Read more...} */ currentCoverageVisible?: boolean; /** * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#dataCaptureEnabled Read more...} */ dataCaptureEnabled?: boolean; /** * When `false`, the view click interaction is enabled for the oriented imagery viewer widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#disabled Read more...} */ disabled?: boolean; /** * Indicates if the image gallery functionality is available in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#galleryOpened Read more...} */ galleryOpened?: boolean; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#icon Read more...} */ icon?: string; /** * Indicates if the image enhancement tool is active. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#imageEnhancementToolActive Read more...} */ imageEnhancementToolActive?: boolean; /** * Indicates whether the image overlays tab in the oriented imagery viewer is open. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#imageOverlaysOpened Read more...} */ imageOverlaysOpened?: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible Read more...} */ isAdditionalCoverageVisible?: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible Read more...} */ isAdditionalPointSourcesVisible?: boolean; /** * Specifies the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html OrientedImageryLayer} to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#layer Read more...} */ layer?: OrientedImageryLayer | nullish; /** * Indicates if the map-image location tool is available in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#mapImageConversionToolState Read more...} */ mapImageConversionToolState?: boolean; /** * When `true`, the navigation tool is available in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#navigationToolActive Read more...} */ navigationToolActive?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html#viewModel Read more...} */ viewModel?: OrientedImageryViewerViewModelProperties; } export class OrientedImageryViewerViewModel extends Accessor { /** * Changes the image brightness loaded in the viewer. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#brightness Read more...} */ brightness: number; /** * Changes the image contrast loaded in the viewer. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#contrast Read more...} */ contrast: number; /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#currentCoverageVisible Read more...} */ currentCoverageVisible: boolean; /** * When `false`, the view click interaction enabled for the oriented imagery viewer widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#disabled Read more...} */ disabled: boolean; /** * When `true`, the image gallery functionality is available in the widget. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageGalleryEnabled Read more...} */ readonly imageGalleryEnabled: boolean; /** * Indicates if the image has been loaded onto the oriented imagery viewer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#imageLoaded Read more...} */ readonly imageLoaded: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalCoverageVisible Read more...} */ isAdditionalCoverageVisible: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalPointSourcesVisible Read more...} */ isAdditionalPointSourcesVisible: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html OrientedImageryLayer} associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#layer Read more...} */ layer: OrientedImageryLayer | nullish; /** * Indicates if the map-image location tool available in the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#mapImageConversionToolState Read more...} */ mapImageConversionToolState: boolean; /** * Changes the image sharpness loaded in the viewer. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#sharpness Read more...} */ sharpness: number; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer.html OrientedImageryViewer} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-oriented-imagery-viewer/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html Read more...} */ constructor(properties?: OrientedImageryViewerViewModelProperties); } interface OrientedImageryViewerViewModelProperties { /** * Changes the image brightness loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#brightness Read more...} */ brightness?: number; /** * Changes the image contrast loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#contrast Read more...} */ contrast?: number; /** * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#currentCoverageVisible Read more...} */ currentCoverageVisible?: boolean; /** * When `false`, the view click interaction enabled for the oriented imagery viewer widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#disabled Read more...} */ disabled?: boolean; /** * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalCoverageVisible Read more...} */ isAdditionalCoverageVisible?: boolean; /** * Indicates if the additional camera locations are visible for the selected image loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#isAdditionalPointSourcesVisible Read more...} */ isAdditionalPointSourcesVisible?: boolean; /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OrientedImageryLayer.html OrientedImageryLayer} associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#layer Read more...} */ layer?: OrientedImageryLayer | nullish; /** * Indicates if the map-image location tool available in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#mapImageConversionToolState Read more...} */ mapImageConversionToolState?: boolean; /** * Changes the image sharpness loaded in the viewer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-OrientedImageryViewer-OrientedImageryViewerViewModel.html#sharpness Read more...} */ sharpness?: number; } export interface Popup extends Widget, GoTo, Evented { } export class Popup { /** * Indicates if the widget is active when it is visible and is not {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup-PopupViewModel.html#waitingForResult waiting for results}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#active Read more...} */ readonly active: boolean; /** * Position of the popup in relation to the selected feature. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#alignment Read more...} */ alignment: | "auto" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing" | "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | Function; /** * This closes the popup when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} camera or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} changes. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#autoCloseEnabled Read more...} */ autoCloseEnabled: boolean; /** * Indicates whether the popup displays its content. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#collapsed Read more...} */ readonly collapsed: boolean; /** * The content of the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#content Read more...} */ content: string | HTMLElement | Widget | nullish; /** * Dock position in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#currentDockPosition Read more...} */ readonly currentDockPosition: | "auto" | "top-center" | "top-right" | "top-left" | "bottom-left" | "bottom-center" | "bottom-right" | nullish; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled: boolean; /** * Indicates whether the placement of the popup is docked to the side of the view. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#dockEnabled Read more...} */ dockEnabled: boolean; /** * Docking the popup allows for a better user experience, particularly when opening * popups in apps on mobile devices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#dockOptions Read more...} */ dockOptions: PopupDockOptions; /** * The number of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#features features} available to the popup. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#featureCount Read more...} */ readonly featureCount: number; /** * An array of features associated with the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#features Read more...} */ features: Graphic[]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#title title} of the popup. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#headingLevel Read more...} */ headingLevel: number; /** * Highlight the selected popup feature using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#highlights highlights} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlights highlights} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#highlightEnabled Read more...} */ highlightEnabled: boolean; /** * Icon displayed in the widget's button. * * @default "popup" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#icon Read more...} */ icon: string; /** * Indicates whether to initially display a list of features, or the content for one feature. * * @default "feature" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#initialDisplayMode Read more...} */ initialDisplayMode: "list" | "feature"; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#label Read more...} */ label: string; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#promises Read more...} */ promises: Promise[]; /** * The feature that the widget has drilled into. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedDrillInFeature Read more...} */ readonly selectedDrillInFeature: Graphic | nullish; /** * The selected feature accessed by the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeature Read more...} */ readonly selectedFeature: Graphic | nullish; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex: number; /** * Returns a reference to the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Feature.html Feature} that the Popup is using. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeatureWidget Read more...} */ readonly selectedFeatureWidget: Feature | nullish; /** * The title of the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#title Read more...} */ title: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Popup widget allows users to view content from feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Read more...} */ constructor(properties?: PopupProperties); /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions Read more...} */ get actions(): Collection; set actions(value: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >); /** * Point used to position the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#location Read more...} */ get location(): Point | nullish; set location(value: PointProperties | nullish); /** * This is a class that contains all the logic * (properties and methods) that controls this widget's behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#viewModel Read more...} */ get viewModel(): PopupViewModel; set viewModel(value: PopupViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#visibleElements Read more...} */ get visibleElements(): PopupVisibleElements; set visibleElements(value: PopupVisibleElementsProperties); /** * Use this method to remove focus from the Widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#blur Read more...} */ blur(): void; /** * Removes {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#promises promises}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#features features}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#content content}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#title title} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#location location} from the Popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#clear Read more...} */ clear(): void; /** * Closes the popup by setting its {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#visible visible} property to `false`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#close Read more...} */ close(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Use this method to return feature(s) at a given screen location. * * @param screenPoint An object representing a point on the screen. This point can be in either the MapView or SceneView. * @param options The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#FetchFeaturesOptions options} to pass into the `fetchFeatures` method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#fetchFeatures Read more...} */ fetchFeatures(screenPoint: PopupFetchFeaturesScreenPoint, options?: PopupFetchFeaturesOptions): Promise; /** * Use this method to give focus to the Widget if the widget is able to be focused. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#focus Read more...} */ focus(): void; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Selects the feature at the next index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#next Read more...} */ next(): PopupViewModel; /** * Opens the popup at the given location with content defined either explicitly with `content` * or driven from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} of input features. * * @param options Defines the location and content of the popup when opened. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#open Read more...} */ open(options?: PopupOpenOptions): void; /** * Selects the feature at the previous index in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#previous Read more...} */ previous(): PopupViewModel; /** * Positions the popup on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#reposition Read more...} */ reposition(): void; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#event-trigger-action trigger-action} event and executes the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions action} * at the specified index in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions actions} array. * * @param actionIndex The index of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions action} to execute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#triggerAction Read more...} */ triggerAction(actionIndex: number): void; on(name: "trigger-action", eventHandler: PopupTriggerActionEventHandler): IHandle; } interface PopupProperties extends WidgetProperties, GoToProperties { /** * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle} objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#actions Read more...} */ actions?: CollectionProperties< (ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" }) >; /** * Position of the popup in relation to the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#alignment Read more...} */ alignment?: | "auto" | "top-leading" | "top-trailing" | "bottom-leading" | "bottom-trailing" | "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | Function; /** * This closes the popup when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} camera or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Viewpoint.html Viewpoint} changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#autoCloseEnabled Read more...} */ autoCloseEnabled?: boolean; /** * The content of the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#content Read more...} */ content?: string | HTMLElement | Widget | nullish; /** * Enables automatic creation of a popup template for layers that have popups enabled but no * popupTemplate defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#defaultPopupTemplateEnabled Read more...} */ defaultPopupTemplateEnabled?: boolean; /** * Indicates whether the placement of the popup is docked to the side of the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#dockEnabled Read more...} */ dockEnabled?: boolean; /** * Docking the popup allows for a better user experience, particularly when opening * popups in apps on mobile devices. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#dockOptions Read more...} */ dockOptions?: PopupDockOptions; /** * An array of features associated with the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#features Read more...} */ features?: Graphic[]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#title title} of the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#headingLevel Read more...} */ headingLevel?: number; /** * Highlight the selected popup feature using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#highlights highlights} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#highlights highlights} * set on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#highlightEnabled Read more...} */ highlightEnabled?: boolean; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#icon Read more...} */ icon?: string; /** * Indicates whether to initially display a list of features, or the content for one feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#initialDisplayMode Read more...} */ initialDisplayMode?: "list" | "feature"; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#label Read more...} */ label?: string; /** * Point used to position the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#location Read more...} */ location?: PointProperties | nullish; /** * An array of pending Promises that have not yet been fulfilled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#promises Read more...} */ promises?: Promise[]; /** * Index of the feature that is {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeature selected}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#selectedFeatureIndex Read more...} */ selectedFeatureIndex?: number; /** * The title of the popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#title Read more...} */ title?: string | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * This is a class that contains all the logic * (properties and methods) that controls this widget's behavior. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#viewModel Read more...} */ viewModel?: PopupViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#visibleElements Read more...} */ visibleElements?: PopupVisibleElementsProperties; } export class PopupViewModel extends FeaturesViewModel { /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} widget, which allows users to view * content from feature attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup-PopupViewModel.html Read more...} */ constructor(properties?: PopupViewModelProperties); } interface PopupViewModelProperties extends FeaturesViewModelProperties { } /** * Optional properties to use with the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#fetchFeatures fetchFeatures} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#FetchFeaturesOptions Read more...} */ export interface PopupFetchFeaturesOptions { event?: any; signal?: AbortSignal | nullish; } /** * The resulting features returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#fetchFeatures fetchFeatures} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#FetchPopupFeaturesResult Read more...} */ export interface FetchPopupFeaturesResult { allGraphicsPromise: Promise; location: Point | nullish; } export interface PopupDockOptions { breakpoint?: boolean | PopupDockOptionsBreakpoint; buttonEnabled?: boolean; position?: string | Function; } export interface PopupDockOptionsBreakpoint { width?: number; height?: number; } export interface PopupFetchFeaturesScreenPoint { x: number; y: number; } export interface PopupOpenOptions { title?: string; content?: string | HTMLElement | Widget; location?: Point; fetchFeatures?: boolean; features?: Graphic[]; promises?: Promise[]; featureMenuOpen?: boolean; updateLocationEnabled?: boolean; collapsed?: boolean; shouldFocus?: boolean; } export interface PopupTriggerActionEvent { action: ActionButton | ActionToggle; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#VisibleElements Read more...} */ export interface PopupVisibleElementsProperties { actionBar?: boolean; closeButton?: boolean; collapseButton?: boolean; featureMenuHeading?: boolean; featureNavigation?: boolean; featureListLayerTitle?: boolean; heading?: boolean; spinner?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html#VisibleElements Read more...} */ export interface PopupVisibleElements extends AnonymousAccessor { actionBar: boolean; closeButton: boolean; collapseButton: boolean; featureMenuHeading: boolean; featureNavigation: boolean; featureListLayerTitle: boolean; heading: boolean; 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#allowedFormats Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#allowedLayouts Read more...} */ allowedLayouts: string | string[]; /** * This option allows passing extra parameters (in addition to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateOptions templateOptions}) to the print (export webmap) requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#extraParameters Read more...} */ extraParameters: any | nullish; /** * Indicates the heading level to use for the "Exported files" text where users can * access the exported map printout. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "print" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#icon Read more...} */ icon: string; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplates defaultTemplates}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#includeDefaultTemplates Read more...} */ includeDefaultTemplates: boolean; /** * Indicates whether or not to include templates from an organization's portal. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#includeOrganizationTemplates Read more...} */ includeOrganizationTemplates: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#label Read more...} */ label: string; /** * The URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#printServiceUrl Read more...} */ printServiceUrl: string | nullish; /** * The initial state of the print area toggle in the Print widget UI. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#showPrintAreaEnabled Read more...} */ showPrintAreaEnabled: boolean; /** * An object containing an array of `customTextElements` name-value pair objects * for each print template in a custom print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateCustomTextElements Read more...} */ templateCustomTextElements: HashMap[]> | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#view Read more...} */ view: MapView | nullish; /** * The Print widget connects your application with a [printing service](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Read more...} */ constructor(properties?: PrintProperties); /** * The collection of links exported from the Print widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#exportedLinks Read more...} */ get exportedLinks(): Collection; set exportedLinks(value: CollectionProperties); /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#portal Read more...} */ get portal(): Portal; set portal(value: PortalProperties); /** * Defines the layout template options used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Print} widget to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateOptions Read more...} */ get templateOptions(): TemplateOptions; set templateOptions(value: TemplateOptionsProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#viewModel Read more...} */ get viewModel(): PrintViewModel; set viewModel(value: PrintViewModelProperties); 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#allowedFormats Read more...} */ allowedFormats?: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#allowedLayouts Read more...} */ allowedLayouts?: string | string[]; /** * The collection of links exported from the Print widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#exportedLinks Read more...} */ exportedLinks?: CollectionProperties; /** * This option allows passing extra parameters (in addition to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateOptions templateOptions}) to the print (export webmap) requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#extraParameters Read more...} */ extraParameters?: any | nullish; /** * Indicates the heading level to use for the "Exported files" text where users can * access the exported map printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#icon Read more...} */ icon?: string; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplates defaultTemplates}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#includeDefaultTemplates Read more...} */ includeDefaultTemplates?: boolean; /** * Indicates whether or not to include templates from an organization's portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#includeOrganizationTemplates Read more...} */ includeOrganizationTemplates?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#label Read more...} */ label?: string; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#portal Read more...} */ portal?: PortalProperties; /** * The URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#printServiceUrl Read more...} */ printServiceUrl?: string | nullish; /** * The initial state of the print area toggle in the Print widget UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#showPrintAreaEnabled Read more...} */ showPrintAreaEnabled?: boolean; /** * An object containing an array of `customTextElements` name-value pair objects * for each print template in a custom print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateCustomTextElements Read more...} */ templateCustomTextElements?: HashMap[]> | nullish; /** * Defines the layout template options used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Print} widget to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#templateOptions Read more...} */ templateOptions?: TemplateOptionsProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#viewModel Read more...} */ viewModel?: PrintViewModelProperties; } export class CustomTemplate extends Accessor { /** * The template's description. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#description Read more...} */ readonly description: string | nullish; /** * The output format for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#format Read more...} */ format: "jpg" | "png8" | "png32" | "pdf" | "gif" | "tiff" | "aix" | "eps" | "svg" | "svgz" | nullish; /** * Unique id for the template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#id Read more...} */ readonly id: string; /** * The text that appears inside the `Select template` button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#label Read more...} */ readonly label: string | nullish; /** * The layout used for the print output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#layout Read more...} */ 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" | nullish; /** * The portal item associated with layout (if any). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#layoutItem Read more...} */ readonly layoutItem: PortalItem | nullish; /** * Defines the layout elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#layoutOptions Read more...} */ readonly layoutOptions: CustomTemplateLayoutOptions | nullish; /** * Defines the layout template info for the layout item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#layoutTemplateInfo Read more...} */ readonly layoutTemplateInfo: CustomTemplateLayoutTemplateInfo | nullish; /** * This object returns settings for a legend, north arrow and scale bar (if any). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#mapSurroundInfoOptions Read more...} */ readonly mapSurroundInfoOptions: CustomTemplateMapSurroundInfoOptions | nullish; /** * The pageUnits from layoutTemplateInfo. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#pageUnits Read more...} */ readonly pageUnits: any | nullish; /** * Loading state of the template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#state Read more...} */ readonly state: "loaded" | "not-loaded" | "loading" | "error"; /** * The type of CustomTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#type Read more...} */ readonly type: "browse-template" | "default-template" | "print-service-template" | nullish; /** * Defines the custom layout template options used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Print widget} and * {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-print/ Print component} to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html Read more...} */ constructor(properties?: CustomTemplateProperties); } interface CustomTemplateProperties { /** * The output format for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html#format Read more...} */ format?: "jpg" | "png8" | "png32" | "pdf" | "gif" | "tiff" | "aix" | "eps" | "svg" | "svgz" | nullish; } export interface CustomTemplateLayoutOptions { legend?: boolean | nullish; northArrow?: boolean | nullish; } export interface CustomTemplateLayoutTemplateInfo { pageSize?: number[]; pageUnits?: string; layoutOptions?: CustomTemplateLayoutTemplateInfoLayoutOptions; } export interface CustomTemplateLayoutTemplateInfoLayoutOptions { hasTitleText?: boolean; hasAuthorText?: boolean; hasCopyrightText?: boolean; hasLegend?: boolean; customTextElements?: any[]; mapSurroundInfos?: any; } export interface CustomTemplateMapSurroundInfoOptions { legend?: any | nullish; northArrow?: any | nullish; scaleBar?: any | nullish; } export interface PrintViewModel extends Accessor, Evented { } export class PrintViewModel { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * @default "all" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#allowedFormats Read more...} */ 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#allowedLayouts Read more...} */ allowedLayouts: string | string[]; /** * A collection of print templates defined on the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#browseTemplates Read more...} */ readonly browseTemplates: Collection; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html template} which defines the default print template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplate Read more...} */ readonly defaultTemplate: CustomTemplate | nullish; /** * A collection of print templates defined on the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplates Read more...} */ readonly defaultTemplates: Collection; /** * The effective URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#effectivePrintServiceUrl Read more...} */ readonly effectivePrintServiceUrl: string | nullish; /** * Returns an array of objects of all print templates available on the custom print * service to see which templates were published with `customTextElements`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements Read more...} */ readonly effectiveTemplateCustomTextElements: HashMap[]>; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Error.html error} that occurred during printing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#error Read more...} */ readonly error: Error | nullish; /** * This option allows passing extra parameters to the print (export webmap) requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#extraParameters Read more...} */ extraParameters: any | nullish; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplates defaultTemplates}. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#includeDefaultTemplates Read more...} */ includeDefaultTemplates: boolean; /** * An array of portalItem Ids that are used to identify the print templates using layoutItem Id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#portalTemplateIds Read more...} */ readonly portalTemplateIds: string[]; /** * A collection of print templates defined on the Portal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#printServiceTemplates Read more...} */ readonly printServiceTemplates: Collection; /** * The URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#printServiceUrl Read more...} */ printServiceUrl: string | nullish; /** * Print timeout value in milliseconds. * * @default 120000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#printTimeout Read more...} */ printTimeout: number; /** * The initial state of the print area toggle in the UI. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#showPrintAreaEnabled Read more...} */ showPrintAreaEnabled: boolean; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#state Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#templateCustomTextElements Read more...} */ templateCustomTextElements: HashMap[]> | nullish; /** * The service metadata that contains the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#format format} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layout layout} information for the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#templatesInfo Read more...} */ readonly templatesInfo: PrintViewModelTemplatesInfo | nullish; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#updateDelay Read more...} */ updateDelay: number; /** * The view from which Print will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Print} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-print/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html Read more...} */ constructor(properties?: PrintViewModelProperties); /** * The collection of links exported from Print. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#exportedLinks Read more...} */ get exportedLinks(): Collection; set exportedLinks(value: CollectionProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html spatial reference} used to render * the printed map on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#outSpatialReference Read more...} */ get outSpatialReference(): SpatialReference | nullish; set outSpatialReference(value: SpatialReferenceProperties | nullish); /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#portal Read more...} */ get portal(): Portal; set portal(value: PortalProperties); /** * Defines the layout template options to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#templateOptions Read more...} */ get templateOptions(): TemplateOptions; set templateOptions(value: TemplateOptionsProperties); /** * Adds a template to a portal. * * @param portalItem The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html PortalItem} used to create a print template. This template will be added to the `browseTemplates` collection. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#addPortalTemplate Read more...} */ addPortalTemplate(portalItem: PortalItem | nullish): Promise; /** * Applies the specified print template to the `templateOptions` property. * * @param template The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html CustomTemplate} will be applied. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#applyTemplate Read more...} */ applyTemplate(template: CustomTemplate | "map-only" | nullish): Promise; /** * Creates a new {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#FileLink FileLink} object for the given file name. * * @param fileName The base name of the file to be exported (without extension). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#createExportedFileLink Read more...} */ createExportedFileLink(fileName: string): FileLink; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Exports the current print template to a file. * * @param fileName The name of the file to export (without extension). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#export Read more...} */ export(fileName: string): PrintExport; /** * Returns a CustomTemplate with the specified `id`. * * @param id The `id` of the CustomTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#getLayoutTemplateById Read more...} */ getLayoutTemplateById(id: string): CustomTemplate | nullish; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * This method should be called to load the view model's printing resources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#load Read more...} */ load(): Promise; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; /** * Prints (exports) the current MapView according to selected options. * * @param template The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-support-PrintTemplate.html PrintTemplate} is used to specify the layout template options which is then used by the PrintTask to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#print Read more...} */ print(template: PrintTemplate): Promise; /** * Removes Template from `browseTemplates`. * * @param template The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-CustomTemplate.html CustomTemplate} will be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#removePortalTemplate Read more...} */ removePortalTemplate(template: CustomTemplate | nullish): void; /** * Helper method to create print templates from a template options object. * * @param templateOptions * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#toPrintTemplate Read more...} */ toPrintTemplate(templateOptions: TemplateOptions): PrintTemplate; } interface PrintViewModelProperties { /** * Specify the print output file format(s) that the user can select based on the options available from the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#allowedFormats Read more...} */ allowedFormats?: string | string[]; /** * Specify the print output layout(s) that the user can select based on the options available from the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#allowedLayouts Read more...} */ allowedLayouts?: string | string[]; /** * The collection of links exported from Print. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#exportedLinks Read more...} */ exportedLinks?: CollectionProperties; /** * This option allows passing extra parameters to the print (export webmap) requests. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#extraParameters Read more...} */ extraParameters?: any | nullish; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#defaultTemplates defaultTemplates}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#includeDefaultTemplates Read more...} */ includeDefaultTemplates?: boolean; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-SpatialReference.html spatial reference} used to render * the printed map on the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#outSpatialReference Read more...} */ outSpatialReference?: SpatialReferenceProperties | nullish; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#portal Read more...} */ portal?: PortalProperties; /** * The URL of the REST endpoint of the Export Web Map Task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#printServiceUrl Read more...} */ printServiceUrl?: string | nullish; /** * Print timeout value in milliseconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#printTimeout Read more...} */ printTimeout?: number; /** * The initial state of the print area toggle in the UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#showPrintAreaEnabled Read more...} */ showPrintAreaEnabled?: boolean; /** * An object containing an array of `customTextElements` name-value pair objects * for each print template in a custom print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#templateCustomTextElements Read more...} */ templateCustomTextElements?: HashMap[]> | nullish; /** * Defines the layout template options to generate the print page. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#templateOptions Read more...} */ templateOptions?: TemplateOptionsProperties; /** * The time interval in milliseconds between each job status request sent to an asynchronous GP task. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#updateDelay Read more...} */ updateDelay?: number; /** * The view from which Print will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * The printed export. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-PrintViewModel.html#PrintExport Read more...} */ export interface PrintExport { link: FileLink; promise: Promise; } export interface PrintViewModelTemplatesInfo { format?: PrintViewModelTemplatesInfoFormat; layout?: PrintViewModelTemplatesInfoLayout; } export interface PrintViewModelTemplatesInfoFormat { choiceList?: string[]; defaultValue?: string; } export interface PrintViewModelTemplatesInfoLayout { choiceList?: string[]; defaultValue?: string; } export class TemplateOptions extends Accessor { /** * When `false`, the attribution is not displayed on the printout. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#attributionEnabled Read more...} */ attributionEnabled: boolean; /** * The text used for the author if the specified layout contains an author text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#author Read more...} */ author: string | nullish; /** * The text used for the copyright if the specified layout contains an copyright text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#copyright Read more...} */ copyright: string | nullish; /** * Use this prop to display text fields for custom text elements from the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#customTextElements Read more...} */ customTextElements: any[] | nullish; /** * Resolution in dots per inch. * * @default 96 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#dpi Read more...} */ dpi: number; /** * This property only applies when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layout layout} value is `map-only`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#fileName Read more...} */ fileName: string | nullish; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for * rendering. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#forceFeatureAttributes Read more...} */ forceFeatureAttributes: boolean; /** * The output format for the printed map. * * @default "pdf" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#format Read more...} */ format: "jpg" | "aix" | "eps" | "gif" | "pdf" | "png32" | "png8" | "svg" | "svgz" | "tiff"; /** * Map height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#height Read more...} */ height: number | nullish; /** * Unique id of the template. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#id Read more...} */ readonly id: string | nullish; /** * When `true`, tables will be included in the printout request. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#includeTables Read more...} */ includeTables: boolean; /** * The layout used for the print output. * * @default "letter-ansi-a-landscape" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layout Read more...} */ 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" | nullish; /** * When `false`, the legend is not displayed on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#legendEnabled Read more...} */ legendEnabled: boolean | nullish; /** * When `true`, the north arrow will be included on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#northArrowEnabled Read more...} */ northArrowEnabled: boolean | nullish; /** * The map scale of the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scale Read more...} */ scale: number | nullish; /** * When `true`, the scale bar will be included on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scaleBarEnabled Read more...} */ scaleBarEnabled: boolean | nullish; /** * Define whether the printed map should preserve map scale or map extent. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scaleEnabled Read more...} */ scaleEnabled: boolean; /** * The state of the template loading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#state Read more...} */ readonly state: "ready" | "pending" | "error"; /** * The text used for the map title if the specified layout contains a title text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#title Read more...} */ title: string | nullish; /** * Map width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#width Read more...} */ width: number | nullish; /** * Defines the layout template options used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html Print widget} and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-print/ Print component} to generate printed output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html Read more...} */ constructor(properties?: TemplateOptionsProperties); /** * A custom layout hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layoutItem Read more...} */ get layoutItem(): PortalItem | nullish; set layoutItem(value: PortalItemProperties | nullish); } interface TemplateOptionsProperties { /** * When `false`, the attribution is not displayed on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#attributionEnabled Read more...} */ attributionEnabled?: boolean; /** * The text used for the author if the specified layout contains an author text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#author Read more...} */ author?: string | nullish; /** * The text used for the copyright if the specified layout contains an copyright text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#copyright Read more...} */ copyright?: string | nullish; /** * Use this prop to display text fields for custom text elements from the print service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#customTextElements Read more...} */ customTextElements?: any[] | nullish; /** * Resolution in dots per inch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#dpi Read more...} */ dpi?: number; /** * This property only applies when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layout layout} value is `map-only`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#fileName Read more...} */ fileName?: string | nullish; /** * When true, the feature's attributes are included in feature collection layers even when they are not needed for * rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#forceFeatureAttributes Read more...} */ forceFeatureAttributes?: boolean; /** * The output format for the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#format Read more...} */ format?: "jpg" | "aix" | "eps" | "gif" | "pdf" | "png32" | "png8" | "svg" | "svgz" | "tiff"; /** * Map height. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#height Read more...} */ height?: number | nullish; /** * When `true`, tables will be included in the printout request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#includeTables Read more...} */ includeTables?: boolean; /** * The layout used for the print output. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layout Read more...} */ 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" | nullish; /** * A custom layout hosted as a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-portal-PortalItem.html portal item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#layoutItem Read more...} */ layoutItem?: PortalItemProperties | nullish; /** * When `false`, the legend is not displayed on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#legendEnabled Read more...} */ legendEnabled?: boolean | nullish; /** * When `true`, the north arrow will be included on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#northArrowEnabled Read more...} */ northArrowEnabled?: boolean | nullish; /** * The map scale of the printed map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scale Read more...} */ scale?: number | nullish; /** * When `true`, the scale bar will be included on the printout. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scaleBarEnabled Read more...} */ scaleBarEnabled?: boolean | nullish; /** * Define whether the printed map should preserve map scale or map extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#scaleEnabled Read more...} */ scaleEnabled?: boolean; /** * The text used for the map title if the specified layout contains a title text element. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#title Read more...} */ title?: string | nullish; /** * Map width. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print-TemplateOptions.html#width Read more...} */ width?: number | nullish; } export interface PrintCompleteEvent { results: PrintCompleteEventResults; } /** * Represents an exported map request from the result of the Print widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#FileLink Read more...} */ export interface FileLinkProperties { count?: number | nullish; error?: Error | nullish; extension?: string | nullish; name?: string | nullish; state?: "ready" | "error" | "pending"; url?: string; portalItem?: PortalItemProperties | nullish; formattedName?: string | nullish; } /** * Represents an exported map request from the result of the Print widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Print.html#FileLink Read more...} */ export interface FileLink extends AnonymousAccessor { get portalItem(): PortalItem | nullish; set portalItem(value: PortalItemProperties | nullish); count: number | nullish; error: Error | nullish; extension: string | nullish; name: string | nullish; state: "ready" | "error" | "pending"; url: string; formattedName: string | nullish; } export interface PrintSubmitEvent { results: PrintSubmitEventResults; } export interface PrintCompleteEventResults { link: Collection; } export interface PrintSubmitEventResults { link: Collection; } export class ScaleBar extends Widget { /** * Icon which represents the widget. * * @default "actual-size" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#label Read more...} */ label: string; /** * The style for the scale bar. * * @default "line" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#style Read more...} */ style: "ruler" | "line"; /** * Units to use for the scale bar. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#unit Read more...} */ unit: "metric" | "imperial" | "dual"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#view Read more...} */ view: MapView | nullish; /** * The ScaleBar widget displays a scale bar on the map or in a specified HTML node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html Read more...} */ constructor(properties?: ScaleBarProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#viewModel Read more...} */ get viewModel(): ScaleBarViewModel; set viewModel(value: ScaleBarViewModelProperties); } interface ScaleBarProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#label Read more...} */ label?: string; /** * The style for the scale bar. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#style Read more...} */ style?: "ruler" | "line"; /** * Units to use for the scale bar. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#unit Read more...} */ unit?: "metric" | "imperial" | "dual"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html#viewModel Read more...} */ viewModel?: ScaleBarViewModelProperties; } export class ScaleBarViewModel extends Accessor { /** * The current state of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar-ScaleBarViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar-ScaleBarViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-scale-bar/ Scale Bar} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar.html ScaleBar} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar-ScaleBarViewModel.html Read more...} */ constructor(properties?: ScaleBarViewModelProperties); /** * Computes the size and units of the scale bar widget given a base length in pixels. * * @param length The base width of the scale bar widget in pixels. * @param measurementSystem The measurement system to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar-ScaleBarViewModel.html#getScaleBarProperties Read more...} */ getScaleBarProperties(length: number, measurementSystem: "imperial" | "metric"): any | nullish; } interface ScaleBarViewModelProperties { /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleBar-ScaleBarViewModel.html#view Read more...} */ view?: MapView | nullish; } export class ScaleRangeSlider extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#disabled Read more...} */ disabled: boolean; /** * Icon displayed in the widget's button. * * @default "actual-size" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#label Read more...} */ label: string; /** * When provided, the initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScale minScale} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScale maxScale} values will match the layer's. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#layer Read more...} */ layer: Layer | Sublayer | nullish; /** * The maximum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScale Read more...} */ maxScale: number; /** * The lowest possible maximum scale value on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScaleLimit Read more...} */ maxScaleLimit: number; /** * The minimum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScale Read more...} */ minScale: number; /** * The highest possible minimum scale value on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScaleLimit Read more...} */ minScaleLimit: number; /** * The mode of the widget, indicating which slider thumbs can be adjusted. * * @default "range" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#mode Read more...} */ mode: "range" | "max-scale-only" | "min-scale-only"; /** * The region that the scale thumbnails will focus on. * * @default "US" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#region Read more...} */ region: SupportedRegion; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#visibleElements Read more...} */ visibleElements: ScaleRangeSliderVisibleElements; /** * The ScaleRangeSlider widget allows the user to set a minimum and maximum scale based on named scale ranges. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html Read more...} */ constructor(properties?: ScaleRangeSliderProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#viewModel Read more...} */ get viewModel(): ScaleRangeSliderViewModel; set viewModel(value: ScaleRangeSliderViewModelProperties); } interface ScaleRangeSliderProperties extends WidgetProperties { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#disabled Read more...} */ disabled?: boolean; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#label Read more...} */ label?: string; /** * When provided, the initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScale minScale} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScale maxScale} values will match the layer's. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#layer Read more...} */ layer?: Layer | Sublayer | nullish; /** * The maximum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScale Read more...} */ maxScale?: number; /** * The lowest possible maximum scale value on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#maxScaleLimit Read more...} */ maxScaleLimit?: number; /** * The minimum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScale Read more...} */ minScale?: number; /** * The highest possible minimum scale value on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#minScaleLimit Read more...} */ minScaleLimit?: number; /** * The mode of the widget, indicating which slider thumbs can be adjusted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#mode Read more...} */ mode?: "range" | "max-scale-only" | "min-scale-only"; /** * The region that the scale thumbnails will focus on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#region Read more...} */ region?: SupportedRegion; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#viewModel Read more...} */ viewModel?: ScaleRangeSliderViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#visibleElements Read more...} */ visibleElements?: ScaleRangeSliderVisibleElements; } export class ScaleRanges extends Accessor { /** * The ScaleRanges class represents the ranges of scales for the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html ScaleRangeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html Read more...} */ constructor(properties?: ScaleRangesProperties); /** * Clamps the scale to the closest minScale or maxScale on the scale range. * * @param scale The scale value from the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#clampScale Read more...} */ clampScale(scale: number): number; /** * Determines whether the given scale is within the current scale range. * * @param scale The scale value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#contains Read more...} */ contains(scale: number): boolean; /** * Finds the scale range name at a given index. * * @param index The index of the scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#findScaleRangeByIndex Read more...} */ findScaleRangeByIndex(index: number): NamedScaleRange; /** * Determines if the input scale value can be considered to be at the smallest scale range edge. * * @param scale The scale value to test against the scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#isMaxScaleEdge Read more...} */ isMaxScaleEdge(scale: number): boolean; /** * Determines if the input scale value can be considered to be at the largest scale range edge. * * @param scale The scale value to test against the scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#isMinScaleEdge Read more...} */ isMinScaleEdge(scale: number): boolean; /** * Helper to create a ScaleRanges object from a minimum and maximum scale. * * @param scaleRange The scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#fromScaleRange Read more...} */ static fromScaleRange(scaleRange: ScaleRangesFromScaleRangeScaleRange): ScaleRanges; } interface ScaleRangesProperties { } /** * The NamedScaleRange provides the minimum and maximum scale of an named scale id. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRanges.html#NamedScaleRange Read more...} */ export interface NamedScaleRange { id: string; minScale: number; maxScale: number; } export interface ScaleRangesFromScaleRangeScaleRange { minScale: number; maxScale: number; } export class ScaleRangeSliderViewModel extends Accessor { /** * When provided, the initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale minScale} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale maxScale} values will match the layer's. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#layer Read more...} */ layer: Layer | Sublayer | nullish; /** * The maximum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale Read more...} */ maxScale: number; /** * The lowest possible maximum scale value from the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScaleLimit Read more...} */ maxScaleLimit: number; /** * The minimum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale Read more...} */ minScale: number; /** * The highest possible minimum scale value from the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScaleLimit Read more...} */ minScaleLimit: number; /** * The valid scale ranges available based on the slider position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#scaleRanges Read more...} */ readonly scaleRanges: ScaleRanges; /** * The current state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html ScaleRangeSlider} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-scale-range-slider/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html Read more...} */ constructor(properties?: ScaleRangeSliderViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html SliderViewModel} * for supporting the scale range slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#sliderViewModel Read more...} */ get sliderViewModel(): SliderViewModel; set sliderViewModel(value: SliderViewModelProperties); /** * Utility method for converting scale-to-slider values. * * @param scale The map scale to be converted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#mapScaleToSlider Read more...} */ mapScaleToSlider(scale: number): number; /** * Utility method for converting slider-to-scale values. * * @param value The value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#mapSliderToScale Read more...} */ mapSliderToScale(value: number): number; } interface ScaleRangeSliderViewModelProperties { /** * When provided, the initial {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale minScale} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale maxScale} values will match the layer's. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#layer Read more...} */ layer?: Layer | Sublayer | nullish; /** * The maximum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScale Read more...} */ maxScale?: number; /** * The lowest possible maximum scale value from the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#maxScaleLimit Read more...} */ maxScaleLimit?: number; /** * The minimum scale of the active scale range. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScale Read more...} */ minScale?: number; /** * The highest possible minimum scale value from the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#minScaleLimit Read more...} */ minScaleLimit?: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html SliderViewModel} * for supporting the scale range slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#sliderViewModel Read more...} */ sliderViewModel?: SliderViewModelProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider-ScaleRangeSliderViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * The region that the scale thumbnails will focus on. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#SupportedRegion Read more...} */ 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" | "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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ScaleRangeSlider.html#VisibleElements Read more...} */ export interface ScaleRangeSliderVisibleElements { preview?: boolean; scaleMenus?: boolean | VisibleElementsScaleMenus; } export interface VisibleElementsScaleMenus { minScaleMenu?: boolean; maxScaleMenu?: boolean; } export interface widgetsSearch extends Widget, GoTo { } export class widgetsSearch { /** * The current active menu of the Search widget. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#activeMenu Read more...} */ activeMenu: "none" | "suggestion" | "source" | "warning"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources source} object currently selected. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#activeSource Read more...} */ readonly activeSource: LayerSearchSource | LocatorSearchSource | nullish; /** * The selected source's index. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#activeSourceIndex Read more...} */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#allPlaceholder Read more...} */ allPlaceholder: string | nullish; /** * The combined collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#sources sources}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#allSources Read more...} */ readonly allSources: Collection; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#autoSelect Read more...} */ autoSelect: boolean; /** * A read-only property that is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} * of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html LayerSearchSource} * and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html LocatorSearchSource}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#defaultSources Read more...} */ readonly defaultSources: Collection; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#disabled Read more...} */ disabled: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Icon which represents the widget. * * @default "search" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#icon Read more...} */ icon: string; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} in the Search UI. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#includeDefaultSources Read more...} */ includeDefaultSources: boolean | Function; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#label Read more...} */ label: string; /** * Enables location services within the widget. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#locationEnabled Read more...} */ locationEnabled: boolean; /** * The maximum number of results returned by the widget if not specified by the source. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#maxResults Read more...} */ maxResults: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#maxSuggestions Read more...} */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#minSuggestCharacters Read more...} */ minSuggestCharacters: number; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} on feature click. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The graphic used to highlight the resulting feature or location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#resultGraphic Read more...} */ readonly resultGraphic: Graphic | nullish; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#resultGraphic resultGraphic} will display at the * location of the selected feature. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled: boolean; /** * An array of objects, each containing a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#SearchResult SearchResult} from the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#results Read more...} */ readonly results: any[] | nullish; /** * Indicates whether to display the option to search all sources. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#searchAllEnabled Read more...} */ searchAllEnabled: boolean; /** * The value of the search box input text string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#searchTerm Read more...} */ searchTerm: string; /** * The result selected from a search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#selectedResult Read more...} */ readonly selectedResult: SearchSearchResult | nullish; /** * An array of results from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggest suggest method}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggestions Read more...} */ readonly suggestions: SuggestResults[] | nullish; /** * Enable suggestions for the widget. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggestionsEnabled Read more...} */ suggestionsEnabled: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Search widget provides a way to perform search operations on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator service(s)}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html map}/{@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature} service feature * layer(s), {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayers} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html BuildingComponentSublayer} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html OGCFeatureLayer}, and/or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table(s)}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Read more...} */ constructor(properties?: widgetsSearchProperties); /** * A customized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} for the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * It is possible to search a specified portal instance's [locator services](http://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) * Use this property to set this [GeoScene Portal](https://enterprise.geosceneonline.cn/zh/portal/) instance to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#portal Read more...} */ get portal(): Portal | nullish; set portal(value: PortalProperties | nullish); /** * The Search widget may be used to search features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html map}/{@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature} service feature * layer(s), {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayers} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html BuildingComponentSublayer} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html OGCFeatureLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table}, * or geocode locations with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources Read more...} */ get sources(): Collection; set sources(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#viewModel Read more...} */ get viewModel(): SearchViewModel; set viewModel(value: SearchViewModelProperties); /** * Unfocuses the widget's text input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#blur Read more...} */ blur(): void; /** * Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#clear Read more...} */ clear(): void; /** * Brings focus to the widget's text input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#focus Read more...} */ focus(): void; /** * Depending on the sources specified, search() queries the feature layer(s) and/or performs * address matching using any specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator(s)} and * returns any applicable results. * * @param searchTerm This searchTerm can be a string, geometry, suggest candidate object, or an array of [longitude,latitude] coordinate pairs. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#search Read more...} */ search(searchTerm?: string | Point | SearchSuggestResult | number[] | nullish): Promise; /** * Performs a suggest() request on the active Locator. * * @param value The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggest Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#activeMenu Read more...} */ activeMenu?: "none" | "suggestion" | "source" | "warning"; /** * The selected source's index. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#activeSourceIndex Read more...} */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#allPlaceholder Read more...} */ allPlaceholder?: string | nullish; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#autoSelect Read more...} */ autoSelect?: boolean; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#disabled Read more...} */ disabled?: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#icon Read more...} */ icon?: string; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} in the Search UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#includeDefaultSources Read more...} */ includeDefaultSources?: boolean | Function; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#label Read more...} */ label?: string; /** * Enables location services within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#locationEnabled Read more...} */ locationEnabled?: boolean; /** * The maximum number of results returned by the widget if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#maxResults Read more...} */ maxResults?: number; /** * The maximum number of suggestions returned by the widget if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#maxSuggestions Read more...} */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#minSuggestCharacters Read more...} */ minSuggestCharacters?: number; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} on feature click. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * A customized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} for the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * It is possible to search a specified portal instance's [locator services](http://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) * Use this property to set this [GeoScene Portal](https://enterprise.geosceneonline.cn/zh/portal/) instance to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#portal Read more...} */ portal?: PortalProperties | nullish; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#resultGraphic resultGraphic} will display at the * location of the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#searchAllEnabled Read more...} */ searchAllEnabled?: boolean; /** * The value of the search box input text string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#searchTerm Read more...} */ searchTerm?: string; /** * The Search widget may be used to search features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html map}/{@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature} service feature * layer(s), {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-SceneLayer.html SceneLayers} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-buildingSublayers-BuildingComponentSublayer.html BuildingComponentSublayer} with an associated feature layer, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GeoJSONLayer.html GeoJSONLayer}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-CSVLayer.html CSVLayer} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-OGCFeatureLayer.html OGCFeatureLayer}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table}, * or geocode locations with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources Read more...} */ sources?: CollectionProperties; /** * Enable suggestions for the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggestionsEnabled Read more...} */ suggestionsEnabled?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#viewModel Read more...} */ viewModel?: SearchViewModelProperties; } export interface LayerSearchSource extends SearchSource, JSONSupport { } export class LayerSearchSource { /** * The results are displayed using this field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#displayField Read more...} */ displayField: string | nullish; /** * Indicates to only return results that match the * search value exactly. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#exactMatch Read more...} */ exactMatch: boolean | nullish; /** * The layer queried in the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#layer Read more...} */ layer: Layer; /** * The name of the source for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#name Read more...} */ name: string; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#orderByFields Read more...} */ orderByFields: string[] | nullish; /** * An array of string values representing the * names of fields in the feature layer to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#searchFields Read more...} */ searchFields: string[] | nullish; /** * A template string used to display multiple * fields in a defined order when results are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#searchTemplate Read more...} */ searchTemplate: string | nullish; /** * A template string used to display multiple * fields in a defined order * when suggestions are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#suggestionTemplate Read more...} */ suggestionTemplate: string | nullish; /** * The following properties define a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}-based {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources source} whose * features may be searched by a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Search widget} or {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-search/ Search component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html Read more...} */ constructor(properties?: LayerSearchSourceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#clone Read more...} */ clone(): LayerSearchSource; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LayerSearchSource; } interface LayerSearchSourceProperties extends SearchSourceProperties { /** * The results are displayed using this field. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#displayField Read more...} */ displayField?: string | nullish; /** * Indicates to only return results that match the * search value exactly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#exactMatch Read more...} */ exactMatch?: boolean | nullish; /** * The layer queried in the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#layer Read more...} */ layer?: Layer; /** * The name of the source for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#name Read more...} */ name?: string; /** * One or more field names used to order the query results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#orderByFields Read more...} */ orderByFields?: string[] | nullish; /** * An array of string values representing the * names of fields in the feature layer to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#searchFields Read more...} */ searchFields?: string[] | nullish; /** * A template string used to display multiple * fields in a defined order when results are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#searchTemplate Read more...} */ searchTemplate?: string | nullish; /** * A template string used to display multiple * fields in a defined order * when suggestions are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html#suggestionTemplate Read more...} */ suggestionTemplate?: string | nullish; } export interface LocatorSearchSource extends SearchSource, JSONSupport { } export class LocatorSearchSource { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#apiKey Read more...} */ apiKey: string | nullish; /** * A string array which limits the results to one * or more categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#categories Read more...} */ categories: string[] | nullish; /** * Constricts search results to a specified country code. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#countryCode Read more...} */ countryCode: string | nullish; /** * Sets the scale of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#scale SceneView} * for the resulting search result, if the locator service doesn't return an extent with a scale. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#defaultZoomScale Read more...} */ defaultZoomScale: number | nullish; /** * This property controls prioritization of Search result * candidates depending on the view scale. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#localSearchDisabled Read more...} */ localSearchDisabled: boolean; /** * Defines the type of location, either `street` or `rooftop`, of the point returned from the * [World Geocoding Service](https://doc.geoscene.cn/rest/geocode/api-reference/geocoding-category-filtering.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#locationType Read more...} */ locationType: "rooftop" | "street" | nullish; /** * The name of the source for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#name Read more...} */ name: string; /** * A template string used to display multiple * fields in a defined order when results are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#searchTemplate Read more...} */ searchTemplate: string; /** * The field name of the Single Line Address * Field in the REST services directory for the locator service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#singleLineFieldName Read more...} */ singleLineFieldName: string | nullish; /** * URL to the GeoScene Server REST resource that represents a locator service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#url Read more...} */ url: string | nullish; /** * The following properties define a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources source} pointing to a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#url url} that represents a locator service, which may be used to geocode locations * with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Search widget} or {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-search/ Search component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html Read more...} */ constructor(properties?: LocatorSearchSourceProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#clone Read more...} */ clone(): LocatorSearchSource; /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): LocatorSearchSource; } interface LocatorSearchSourceProperties extends SearchSourceProperties { /** * An authorization string used to access a resource or service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#apiKey Read more...} */ apiKey?: string | nullish; /** * A string array which limits the results to one * or more categories. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#categories Read more...} */ categories?: string[] | nullish; /** * Constricts search results to a specified country code. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#countryCode Read more...} */ countryCode?: string | nullish; /** * Sets the scale of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#scale MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#scale SceneView} * for the resulting search result, if the locator service doesn't return an extent with a scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#defaultZoomScale Read more...} */ defaultZoomScale?: number | nullish; /** * This property controls prioritization of Search result * candidates depending on the view scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#localSearchDisabled Read more...} */ localSearchDisabled?: boolean; /** * Defines the type of location, either `street` or `rooftop`, of the point returned from the * [World Geocoding Service](https://doc.geoscene.cn/rest/geocode/api-reference/geocoding-category-filtering.htm). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#locationType Read more...} */ locationType?: "rooftop" | "street" | nullish; /** * The name of the source for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#name Read more...} */ name?: string; /** * A template string used to display multiple * fields in a defined order when results are displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#searchTemplate Read more...} */ searchTemplate?: string; /** * The field name of the Single Line Address * Field in the REST services directory for the locator service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#singleLineFieldName Read more...} */ singleLineFieldName?: string | nullish; /** * URL to the GeoScene Server REST resource that represents a locator service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html#url Read more...} */ url?: string | nullish; } export class SearchResultRenderer extends Widget { /** * Indicates whether to display the `Show more results` link within the search result's popup. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchResultRenderer.html#showMoreResultsOpen Read more...} */ showMoreResultsOpen: boolean; /** * The `SearchResultRenderer` renders the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Search} widget * or {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-search/ Search component} results and allows expanding a DOM element to show alternative matches. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchResultRenderer.html Read more...} */ constructor(properties?: SearchResultRendererProperties); /** * The view model for this Search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchResultRenderer.html#viewModel Read more...} */ get viewModel(): SearchViewModel | nullish; set viewModel(value: SearchViewModelProperties | nullish); } interface SearchResultRendererProperties extends WidgetProperties { /** * Indicates whether to display the `Show more results` link within the search result's popup. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchResultRenderer.html#showMoreResultsOpen Read more...} */ showMoreResultsOpen?: boolean; /** * The view model for this Search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchResultRenderer.html#viewModel Read more...} */ viewModel?: SearchViewModelProperties | nullish; } export interface SearchSource extends Accessor, JSONSupport, Identifiable { } export class SearchSource { /** * Indicates whether to automatically navigate to the * selected result once selected. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#autoNavigate Read more...} */ autoNavigate: boolean | nullish; /** * For filtering suggests or search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#filter Read more...} */ filter: SearchSourceFilter | nullish; /** * Function used to get search results. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#getResults Read more...} */ getResults: GetResultsHandler | nullish; /** * Function used to get search suggestions. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#getSuggestions Read more...} */ getSuggestions: GetSuggestionsParameters | nullish; /** * Indicates the maximum number of search results to return. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#maxResults Read more...} */ maxResults: number | nullish; /** * Indicates the maximum number of suggestions * to return for the widget's input. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#maxSuggestions Read more...} */ maxSuggestions: number | nullish; /** * Indicates the minimum number of characters * required before querying for a suggestion. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#minSuggestCharacters Read more...} */ minSuggestCharacters: number | nullish; /** * Specifies the fields returned with the search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#outFields Read more...} */ outFields: string[] | nullish; /** * Used as a hint for the source input text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#placeholder Read more...} */ placeholder: string | nullish; /** * Indicates whether to display a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when a selected result is clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#popupEnabled Read more...} */ popupEnabled: boolean | nullish; /** * Specify this to prefix the user's input of the search text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#prefix Read more...} */ prefix: string; /** * Indicates whether to show a graphic on the * map for the selected source using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultSymbol resultSymbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled: boolean | nullish; /** * The symbol used to display the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultSymbol Read more...} */ resultSymbol: SymbolUnion | nullish; /** * Specify this to add a suffix to the user's input for the search value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#suffix Read more...} */ suffix: string; /** * Indicates whether to display suggestions * as the user enters input text in the widget. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#suggestionsEnabled Read more...} */ suggestionsEnabled: boolean | nullish; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * Indicates whether to constrain the search * results to the view's extent. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#withinViewEnabled Read more...} */ withinViewEnabled: boolean; /** * The set zoom scale for the resulting search result. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#zoomScale Read more...} */ zoomScale: number | nullish; /** * The following properties define generic {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#sources sources} properties * for use in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Search widget} or {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-search/ Search component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html Read more...} */ constructor(properties?: SearchSourceProperties); /** * The popup template used to display search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * Converts an instance of this class to its [GeoScene portal JSON](https://doc.geoscene.cn/documentation/common-data-types/geometry-objects.htm) representation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#toJSON Read more...} */ toJSON(): any; /** * Creates a new instance of this class and initializes it with values from a JSON object * generated from an GeoScene product. * * @param json A JSON representation of the instance in the GeoScene format. See the [GeoScene REST API documentation](https://doc.geoscene.cn/documentation/common-data-types/overview-of-common-data-types.htm) for examples of the structure of various input JSON objects. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#fromJSON Read more...} */ static fromJSON(json: any): any | nullish; static fromJSON(json: any): SearchSource; } interface SearchSourceProperties extends IdentifiableProperties { /** * Indicates whether to automatically navigate to the * selected result once selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#autoNavigate Read more...} */ autoNavigate?: boolean | nullish; /** * For filtering suggests or search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#filter Read more...} */ filter?: SearchSourceFilter | nullish; /** * Function used to get search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#getResults Read more...} */ getResults?: GetResultsHandler | nullish; /** * Function used to get search suggestions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#getSuggestions Read more...} */ getSuggestions?: GetSuggestionsParameters | nullish; /** * Indicates the maximum number of search results to return. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#maxResults Read more...} */ maxResults?: number | nullish; /** * Indicates the maximum number of suggestions * to return for the widget's input. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#maxSuggestions Read more...} */ maxSuggestions?: number | nullish; /** * Indicates the minimum number of characters * required before querying for a suggestion. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#minSuggestCharacters Read more...} */ minSuggestCharacters?: number | nullish; /** * Specifies the fields returned with the search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#outFields Read more...} */ outFields?: string[] | nullish; /** * Used as a hint for the source input text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#placeholder Read more...} */ placeholder?: string | nullish; /** * Indicates whether to display a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} when a selected result is clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#popupEnabled Read more...} */ popupEnabled?: boolean | nullish; /** * The popup template used to display search results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * Specify this to prefix the user's input of the search text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#prefix Read more...} */ prefix?: string; /** * Indicates whether to show a graphic on the * map for the selected source using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultSymbol resultSymbol}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled?: boolean | nullish; /** * The symbol used to display the result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#resultSymbol Read more...} */ resultSymbol?: SymbolUnion | nullish; /** * Specify this to add a suffix to the user's input for the search value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#suffix Read more...} */ suffix?: string; /** * Indicates whether to display suggestions * as the user enters input text in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#suggestionsEnabled Read more...} */ suggestionsEnabled?: boolean | nullish; /** * Indicates whether to constrain the search * results to the view's extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#withinViewEnabled Read more...} */ withinViewEnabled?: boolean; /** * The set zoom scale for the resulting search result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchSource.html#zoomScale Read more...} */ zoomScale?: number | nullish; } export type GetResultsHandler = (params: GetResultsHandlerParams) => Promise; export type GetSuggestionsParameters = ( params: GetSuggestionsParametersParams, ) => Promise; export interface SearchSourceFilter { where?: string; geometry?: GeometryUnion; } export interface GetResultsHandlerParams { exactMatch?: boolean; location?: Point; maxResults?: number; sourceIndex?: number; spatialReference?: SpatialReference; suggestResult: SearchSuggestResult; view?: MapView | SceneView; } export interface GetSuggestionsParametersParams { suggestTerm: string; maxSuggestions?: number; sourceIndex?: number; spatialReference?: SpatialReference; view?: MapView | SceneView; } export interface SearchViewModel extends Accessor, Evented, GoTo { } export class SearchViewModel { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#sources source} object currently selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#activeSource Read more...} */ readonly activeSource: LayerSearchSource | LocatorSearchSource | nullish; /** * The selected source's index. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#activeSourceIndex Read more...} */ activeSourceIndex: number; /** * String value used as a hint for input text when searching on multiple sources. * * @default "Find address or place" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#allPlaceholder Read more...} */ allPlaceholder: string | nullish; /** * The combined collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} * and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#sources sources}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#allSources Read more...} */ readonly allSources: Collection; /** * Indicates whether to automatically navigate to the selected result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#autoNavigate Read more...} */ autoNavigate: boolean; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#autoSelect Read more...} */ autoSelect: boolean; /** * A read-only property that is a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-core-Collection.html Collection} * of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LayerSearchSource.html LayerSearchSource} * and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-LocatorSearchSource.html LocatorSearchSource}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources Read more...} */ readonly defaultSources: Collection; /** * The default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html symbol(s)} for the search result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSymbols Read more...} */ defaultSymbols: SearchViewModelDefaultSymbols; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} in the Search UI. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#includeDefaultSources Read more...} */ includeDefaultSources: boolean | Function; /** * Indicates whether location services are enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#locationEnabled Read more...} */ locationEnabled: boolean; /** * The maximum character length of the search text. * * @default 128 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxInputLength Read more...} */ maxInputLength: number; /** * The maximum number of results returned if not specified by the source. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxResults Read more...} */ maxResults: number; /** * The maximum number of suggestions returned if not specified by the source. * * @default 6 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxSuggestions Read more...} */ maxSuggestions: number; /** * The minimum number of characters needed for the search if not specified by the source. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#minSuggestCharacters Read more...} */ minSuggestCharacters: number; /** * The placeholder used by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#activeSource activeSource}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#placeholder Read more...} */ readonly placeholder: string; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} on feature click. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#popupEnabled Read more...} */ popupEnabled: boolean; /** * The number of results found in the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultCount Read more...} */ resultCount: number | nullish; /** * The graphic used to highlight the resulting feature or location. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultGraphic Read more...} */ readonly resultGraphic: Graphic | nullish; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultGraphic resultGraphic} will display at the * location of the selected feature. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled: boolean; /** * An array of current results from the search. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#results Read more...} */ readonly results: SearchResults[] | nullish; /** * Indicates whether to display the option to search all sources. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#searchAllEnabled Read more...} */ searchAllEnabled: boolean; /** * The value of the search box input text string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#searchTerm Read more...} */ searchTerm: string; /** * The result selected from a search. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#selectedResult Read more...} */ readonly selectedResult: SearchResult | nullish; /** * The selected SuggestResult. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#selectedSuggestion Read more...} */ readonly selectedSuggestion: GeometryUnion | SuggestResult | nullish; /** * The current state. * * @default "ready" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "searching" | "loading"; /** * The number of suggestions found for the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionCount Read more...} */ suggestionCount: number | nullish; /** * The millisecond delay after keyup and before making a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggest suggest} network request. * * @default 350 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionDelay Read more...} */ suggestionDelay: number; /** * An array of results from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggest suggest method}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestions Read more...} */ readonly suggestions: SuggestResults[] | nullish; /** * Enable suggestions. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionsEnabled Read more...} */ suggestionsEnabled: boolean; /** * Indicates whether the `View` or `Portal` is loading resources prior to use. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#updating Read more...} */ readonly updating: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html Search widget} and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-search/ Search component}, which performs search * operations on {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator service(s)}, * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-MapImageLayer.html map}/{@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html feature} service feature * layer(s), and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table(s)}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html Read more...} */ constructor(properties?: SearchViewModelProperties); /** * The default popupTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultPopupTemplate Read more...} */ get defaultPopupTemplate(): PopupTemplate | nullish; set defaultPopupTemplate(value: PopupTemplateProperties | nullish); /** * A customized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} for the selected feature. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#popupTemplate Read more...} */ get popupTemplate(): PopupTemplate | nullish; set popupTemplate(value: PopupTemplateProperties | nullish); /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) * Use this property to set this [GeoScene Portal](https://enterprise.geosceneonline.cn/zh/portal/) instance to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#portal Read more...} */ get portal(): Portal | nullish; set portal(value: PortalProperties | nullish); /** * Search may be used to search features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table}, * or geocode locations with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#sources Read more...} */ get sources(): Collection; set sources(value: CollectionProperties); /** * Clears the current value, search results, suggest results, graphic, and graphics layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#clear Read more...} */ clear(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Depending on the sources specified, `search()` queries the feature layer(s) and/or performs * address matching using any specified {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html Locator(s)} and * returns the applicable results. * * @param searchItem This searchItem can be a string, point geometry, suggest candidate object, or an array containing [latitude,longitude]. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text (featurelayer). * @param options An object containing an optional `signal` property that can be used to cancel the request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#search Read more...} */ search(searchItem?: string | Graphic | Point | SuggestResult | number[] | nullish, options?: any): Promise; /** * Returns search results near your current location. * * @param options An object containing an optional `signal` property that can be used to cancel the request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#searchNearby Read more...} */ searchNearby(options?: any): Promise; /** * Selects a result. * * @param value The result object to select. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#select Read more...} */ select(value: any): Promise; /** * Performs a suggest() request on the active Locator. * * @param value The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value. * @param suggestionDelay The millisecond delay after keyup and before making a `suggest()` network request. * @param options An object containing an optional `signal` property that can be used to cancel the request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggest Read more...} */ suggest(value?: string, suggestionDelay?: number | nullish, options?: any): Promise; /** * `when()` may be leveraged once the `SearchViewModel` has been updated. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#when Read more...} */ when(callback?: Function, errback?: Function): 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#activeSourceIndex Read more...} */ activeSourceIndex?: number; /** * String value used as a hint for input text when searching on multiple sources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#allPlaceholder Read more...} */ allPlaceholder?: string | nullish; /** * Indicates whether to automatically navigate to the selected result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#autoNavigate Read more...} */ autoNavigate?: boolean; /** * Indicates whether to automatically select and zoom to the first geocoded result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#autoSelect Read more...} */ autoSelect?: boolean; /** * The default popupTemplate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultPopupTemplate Read more...} */ defaultPopupTemplate?: PopupTemplateProperties | nullish; /** * The default {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-Symbol.html symbol(s)} for the search result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSymbols Read more...} */ defaultSymbols?: SearchViewModelDefaultSymbols; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * Indicates whether or not to include {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#defaultSources defaultSources} in the Search UI. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#includeDefaultSources Read more...} */ includeDefaultSources?: boolean | Function; /** * Indicates whether location services are enabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#locationEnabled Read more...} */ locationEnabled?: boolean; /** * The maximum character length of the search text. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxInputLength Read more...} */ maxInputLength?: number; /** * The maximum number of results returned if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxResults Read more...} */ maxResults?: number; /** * The maximum number of suggestions returned if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#maxSuggestions Read more...} */ maxSuggestions?: number; /** * The minimum number of characters needed for the search if not specified by the source. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#minSuggestCharacters Read more...} */ minSuggestCharacters?: number; /** * Indicates whether to display the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Popup.html Popup} on feature click. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#popupEnabled Read more...} */ popupEnabled?: boolean; /** * A customized {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-PopupTemplate.html PopupTemplate} for the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#popupTemplate Read more...} */ popupTemplate?: PopupTemplateProperties | nullish; /** * It is possible to search a specified portal instance's [locator services](https://enterprise.geosceneonline.cn/zh/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm) * Use this property to set this [GeoScene Portal](https://enterprise.geosceneonline.cn/zh/portal/) instance to search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#portal Read more...} */ portal?: PortalProperties | nullish; /** * The number of results found in the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultCount Read more...} */ resultCount?: number | nullish; /** * Indicates if the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultGraphic resultGraphic} will display at the * location of the selected feature. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#resultGraphicEnabled Read more...} */ resultGraphicEnabled?: boolean; /** * Indicates whether to display the option to search all sources. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#searchAllEnabled Read more...} */ searchAllEnabled?: boolean; /** * The value of the search box input text string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#searchTerm Read more...} */ searchTerm?: string; /** * Search may be used to search features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-FeatureLayer.html FeatureLayer} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-webdoc-applicationProperties-SearchTable.html table}, * or geocode locations with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-locator.html locator}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#sources Read more...} */ sources?: CollectionProperties; /** * The number of suggestions found for the search. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionCount Read more...} */ suggestionCount?: number | nullish; /** * The millisecond delay after keyup and before making a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggest suggest} network request. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionDelay Read more...} */ suggestionDelay?: number; /** * Enable suggestions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#suggestionsEnabled Read more...} */ suggestionsEnabled?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-SearchViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export interface SearchViewModelSearchClearEvent { } export interface SearchViewModelSearchCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchViewModelSearchCompleteEventResults[]; searchTerm: string; } export interface SearchViewModelSearchStartEvent { } export interface SearchViewModelDefaultSymbols { point?: SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol; polygon?: SimpleFillSymbol | PolygonSymbol3D | CIMSymbol; polyline?: SimpleLineSymbol | LineSymbol3D | CIMSymbol; } export interface SearchViewModelSelectResultEvent { result: SearchViewModelSelectResultEventResult; source: LayerSearchSource | LocatorSearchSource; sourceIndex: number; } export interface SearchViewModelSuggestCompleteEvent { activeSourceIndex: number; errors: Error[]; numResults: number; results: SearchViewModelSuggestCompleteEventResults[]; searchTerm: string; } export interface SearchViewModelSuggestStartEvent { } export interface SearchViewModelSearchCompleteEventResults { results: SearchResults[]; sourceIndex: number; source: LayerSearchSource | LocatorSearchSource; } export interface SearchViewModelSelectResultEventResult { extent: Extent; feature: Graphic; name: string; } export interface SearchViewModelSuggestCompleteEventResults { results: SuggestResult[]; sourceIndex: number; source: LayerSearchSource | LocatorSearchSource; } /** * A module for importing types used in Search modules. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html Read more...} */ namespace SearchTypes { /** * The result object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResult Read more...} */ export interface SearchResult { extent: Extent | nullish; feature: Graphic; target: Graphic; name: string; key: string | number | nullish; sourceIndex: number | nullish; } /** * The result object returned from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResult Read more...} */ export interface SuggestResult { location?: Point; key: string | number | nullish; text: string | nullish; sourceIndex: number | nullish; } /** * Base interface of common search result properties returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#BaseSearchResults Read more...} */ export interface BaseSearchResults { source: LayerSearchSource | LocatorSearchSource; sourceIndex: number; error?: Error; } /** * The array of results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResults Read more...} */ export interface SearchResults extends BaseSearchResults { results?: SearchResult[]; } /** * The array of results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResults Read more...} */ export interface SuggestResults extends BaseSearchResults { results?: SuggestResult[]; } /** * Base interface of common response properties returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#BaseSearchResponse Read more...} */ export interface BaseSearchResponse { activeSourceIndex: number; searchTerm: string; numResults: number; } /** * Result of calling {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResponse Read more...} */ export interface SuggestResponse extends BaseSearchResponse { results: SuggestResults[]; errors: SuggestResults[]; } /** * When resolved, returns this response after calling {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResponse Read more...} */ export interface SearchResponse extends BaseSearchResponse { results: SearchResults[]; errors: SearchResults[]; } } /** * Base interface of common response properties returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#BaseSearchResponse Read more...} */ export interface BaseSearchResponse { activeSourceIndex: number; searchTerm: string; numResults: number; } /** * Base interface of common search result properties returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#BaseSearchResults Read more...} */ export interface BaseSearchResults { source: LayerSearchSource | LocatorSearchSource; sourceIndex: number; error?: Error; } /** * When resolved, returns this response after calling {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResponse Read more...} */ export interface SearchResponse extends BaseSearchResponse { results: SearchResults[]; errors: SearchResults[]; } /** * The result object returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search} results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResult Read more...} */ export interface SearchResult { extent: Extent | nullish; feature: Graphic; target: Graphic; name: string; key: string | number | nullish; sourceIndex: number | nullish; } /** * The array of results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#search search}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SearchResults Read more...} */ export interface SearchResults extends BaseSearchResults { results?: SearchResult[]; } /** * Result of calling {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResponse Read more...} */ export interface SuggestResponse extends BaseSearchResponse { results: SuggestResults[]; errors: SuggestResults[]; } /** * The result object returned from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResult Read more...} */ export interface SuggestResult { location?: Point; key: string | number | nullish; text: string | nullish; sourceIndex: number | nullish; } /** * The array of results returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search-types.html#SuggestResults Read more...} */ export interface SuggestResults extends BaseSearchResults { results?: SuggestResult[]; } 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#search search}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#SearchResponse Read more...} */ export interface SearchSearchResponse { activeSourceIndex: number; errors: SearchResponseErrors[]; numResults: number; searchTerm: string; results: SearchResponseResults[]; } /** * The result object returned from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#search search()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#SearchResult Read more...} */ export interface SearchSearchResult { extent: Extent | nullish; feature: Graphic; name: string; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggest suggest}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#SuggestResponse Read more...} */ export interface SearchSuggestResponse { activeSourceIndex: number; errors: SuggestResponseErrors[]; numResults: number; searchTerm: string; results: SuggestResponseResults[]; } /** * The result object returned from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#suggest suggest()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Search.html#SuggestResult Read more...} */ export interface SearchSuggestResult { key: string | number | nullish; text: string | nullish; sourceIndex: number | nullish; } export interface SearchSuggestStartEvent { } export interface SearchSearchCompleteEventResults { results: SearchSearchResult[]; sourceIndex: number; source: any; } export interface SearchResponseErrors { source: any; sourceIndex: number; error?: Error; } export interface SearchResponseResults { results?: SearchSearchResult[]; sourceIndex: number; source: any; } export interface SearchSelectResultEventResult { extent: Extent; feature: Graphic; name: string; } export interface SearchSuggestCompleteEventResults { results: SearchSuggestResult[]; sourceIndex: number; source: any; } export interface SuggestResponseErrors { source: any; sourceIndex: number; error?: Error; } export interface SuggestResponseResults { results?: SearchSuggestResult[]; sourceIndex: number; source: any; } export class ShadowCast extends Widget { /** * Indicates the heading level to use for the titles "Time range" and "Visualization". * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "measure-building-height-shadow" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#view Read more...} */ view: SceneView | nullish; /** * The ShadowCast widget displays the cumulative shadows of 3D features in a * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html Read more...} */ constructor(properties?: ShadowCastProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#viewModel Read more...} */ get viewModel(): ShadowCastViewModel; set viewModel(value: ShadowCastViewModelProperties); /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#visibleElements Read more...} */ get visibleElements(): ShadowCastVisibleElements; set visibleElements(value: ShadowCastVisibleElementsProperties); } interface ShadowCastProperties extends WidgetProperties { /** * Indicates the heading level to use for the titles "Time range" and "Visualization". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#viewModel Read more...} */ viewModel?: ShadowCastViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#visibleElements Read more...} */ visibleElements?: ShadowCastVisibleElementsProperties; } export class DiscreteOptions extends Accessor { /** * Individual shadows are displayed at this time interval, starting with the start time of day. * * @default 1 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#interval Read more...} */ interval: number; /** * Configuration for the discrete visualization of the Shadow Cast * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html widget} and * {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-shadow-cast/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html Read more...} */ constructor(properties?: DiscreteOptionsProperties); /** * Color of the shadow visualization. * * @default [50, 50, 50, 0.7] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * Values (in minutes) selectable in the UI for the interval used to accumulate shadows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#intervalOptions Read more...} */ get intervalOptions(): Collection; set intervalOptions(value: CollectionProperties); } interface DiscreteOptionsProperties { /** * Color of the shadow visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#color Read more...} */ color?: ColorProperties; /** * Individual shadows are displayed at this time interval, starting with the start time of day. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#interval Read more...} */ interval?: number; /** * Values (in minutes) selectable in the UI for the interval used to accumulate shadows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DiscreteOptions.html#intervalOptions Read more...} */ intervalOptions?: CollectionProperties; } export class DurationOptions extends Accessor { /** * Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly * aggregation of values. * * @default "continuous" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DurationOptions.html#mode Read more...} */ mode: "continuous" | "hourly"; /** * Configuration for the duration visualization of the Shadow Cast * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html widget} and * {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-shadow-cast/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DurationOptions.html Read more...} */ constructor(properties?: DurationOptionsProperties); /** * Color of the shadow visualization. * * @default [0, 0, 255, 0.7] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DurationOptions.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); } interface DurationOptionsProperties { /** * Color of the shadow visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DurationOptions.html#color Read more...} */ color?: ColorProperties; /** * Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly * aggregation of values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-DurationOptions.html#mode Read more...} */ mode?: "continuous" | "hourly"; } export class ShadowCastViewModel extends Accessor { /** * Time (in milliseconds from midnight of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date date}) when the shadow cast computation should stop. * * @default 16 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay Read more...} */ endTimeOfDay: number; /** * Time (in milliseconds from midnight of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date date}) * when the shadow cast computation should start. * * @default 10 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay Read more...} */ startTimeOfDay: number; /** * The current state of the view model that can be used for rendering the UI * of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * The difference in hours between UTC time and the times displayed in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset Read more...} */ utcOffset: number; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Type of visualization to use when showing the shadows. * * @default "threshold" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType Read more...} */ visualizationType: "threshold" | "duration" | "discrete"; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html ShadowCast} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-shadow-cast/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html Read more...} */ constructor(properties?: ShadowCastViewModelProperties); /** * The calendar date used to calculate the shadow cast. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date Read more...} */ get date(): Date; set date(value: DateProperties); /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "discrete". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions Read more...} */ get discreteOptions(): DiscreteOptions; set discreteOptions(value: DiscreteOptionsProperties); /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "duration". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions Read more...} */ get durationOptions(): DurationOptions; set durationOptions(value: DurationOptionsProperties); /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "threshold". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions Read more...} */ get thresholdOptions(): ThresholdOptions; set thresholdOptions(value: ThresholdOptionsProperties); /** * Returns the time (in milliseconds) spent in shadow for a certain point on the screen. * * @param point The point on the screen for which shadow cast is calculated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#getDuration Read more...} */ getDuration(point: SceneViewScreenPoint): Promise; /** * Starts the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#start Read more...} */ start(): void; /** * Stops the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#stop Read more...} */ stop(): void; } interface ShadowCastViewModelProperties { /** * The calendar date used to calculate the shadow cast. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date Read more...} */ date?: DateProperties; /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "discrete". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions Read more...} */ discreteOptions?: DiscreteOptionsProperties; /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "duration". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions Read more...} */ durationOptions?: DurationOptionsProperties; /** * Time (in milliseconds from midnight of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date date}) when the shadow cast computation should stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay Read more...} */ endTimeOfDay?: number; /** * Time (in milliseconds from midnight of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#date date}) * when the shadow cast computation should start. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay Read more...} */ startTimeOfDay?: number; /** * The configuration used when the widget's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType visualizationType} is set to "threshold". * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions Read more...} */ thresholdOptions?: ThresholdOptionsProperties; /** * The difference in hours between UTC time and the times displayed in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset Read more...} */ utcOffset?: number; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#view Read more...} */ view?: SceneView | nullish; /** * Type of visualization to use when showing the shadows. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType Read more...} */ visualizationType?: "threshold" | "duration" | "discrete"; } export class ThresholdOptions extends Accessor { /** * Whether to enable additional context showing discrete shadows at the same time as displaying * the threshold. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextEnabled Read more...} */ contextEnabled: boolean; /** * The maximum time period (in milliseconds) selectable in the UI for the threshold * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value value}. * * @default 8 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#maxValue Read more...} */ maxValue: number; /** * The minimum time period (in milliseconds) selectable in the UI for the threshold * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value value}. * * @default 0 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#minValue Read more...} */ minValue: number; /** * Time period in milliseconds. * * @default 4 * 3600 * 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value Read more...} */ value: number; /** * Configuration for the threshold visualization of the Shadow Cast * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html widget} and * {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-shadow-cast/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html Read more...} */ constructor(properties?: ThresholdOptionsProperties); /** * Color of the shadow visualization. * * @default [255, 0 , 0, 0.7] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#color Read more...} */ get color(): Color; set color(value: ColorProperties); /** * The configuration used when showing additional context by setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextEnabled contextEnabled} * to true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextOptions Read more...} */ get contextOptions(): DiscreteOptions; set contextOptions(value: DiscreteOptionsProperties); } interface ThresholdOptionsProperties { /** * Color of the shadow visualization. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#color Read more...} */ color?: ColorProperties; /** * Whether to enable additional context showing discrete shadows at the same time as displaying * the threshold. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextEnabled Read more...} */ contextEnabled?: boolean; /** * The configuration used when showing additional context by setting {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextEnabled contextEnabled} * to true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#contextOptions Read more...} */ contextOptions?: DiscreteOptionsProperties; /** * The maximum time period (in milliseconds) selectable in the UI for the threshold * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#maxValue Read more...} */ maxValue?: number; /** * The minimum time period (in milliseconds) selectable in the UI for the threshold * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value value}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#minValue Read more...} */ minValue?: number; /** * Time period in milliseconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast-ThresholdOptions.html#value Read more...} */ value?: number; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#VisibleElements Read more...} */ export interface ShadowCastVisibleElementsProperties { timeRangeSlider?: boolean; timezone?: boolean; datePicker?: boolean; visualizationOptions?: boolean; colorPicker?: boolean; tooltip?: boolean; thresholdContext?: boolean; thresholdContextToggle?: boolean; thresholdContextTimeInterval?: boolean; thresholdContextColor?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ShadowCast.html#VisibleElements Read more...} */ export interface ShadowCastVisibleElements extends AnonymousAccessor { timeRangeSlider: boolean; timezone: boolean; datePicker: boolean; visualizationOptions: boolean; colorPicker: boolean; tooltip: boolean; thresholdContext: boolean; thresholdContextToggle: boolean; thresholdContextTimeInterval: boolean; thresholdContextColor: boolean; } export class Sketch extends Widget { /** * When creating new graphics (for example after {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#create create()} has been called), * this property reflects the create tool being used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#activeTool Read more...} */ readonly activeTool: | "point" | "polyline" | "polygon" | "freehandPolyline" | "freehandPolygon" | "multipoint" | "mesh" | "circle" | "rectangle" | "move" | "transform" | "reshape" | "rectangle-selection" | "lasso-selection" | "custom-selection" | nullish; /** * The tooltip currently being displayed for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTool activeTool}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#activeTooltip Read more...} */ readonly activeTooltip: Tooltip | nullish; /** * Property controlling the visibility and order of create tool buttons. * * @default ["point", "polyline", "polygon", "rectangle", "circle"] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#availableCreateTools Read more...} */ availableCreateTools: | ( | "point" | "polyline" | "polygon" | "rectangle" | "circle" | "multipoint" | "freehandPolyline" | "freehandPolygon" | "mesh" )[] | nullish; /** * The graphic that is being created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#createGraphic Read more...} */ readonly createGraphic: Graphic | nullish; /** * Defines the default behavior once the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#create create} operation is completed. * * @default "continuous" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#creationMode Read more...} */ creationMode: "single" | "continuous" | "update"; /** * Default create options set for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#defaultCreateOptions Read more...} */ defaultCreateOptions: SketchDefaultCreateOptions; /** * Default update options set for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#defaultUpdateOptions Read more...} */ defaultUpdateOptions: SketchDefaultUpdateOptions; /** * Icon which represents the widget. * * @default "pencil" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#icon Read more...} */ icon: string; /** * The Sketch widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#label Read more...} */ label: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} associated with the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#layer Read more...} */ layer: GraphicsLayer; /** * Determines the layout/orientation of the Sketch widget. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#layout Read more...} */ layout: "vertical" | "horizontal"; /** * Determines the size of widget elements. * * @default "m" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#scale Read more...} */ scale: "s" | "m" | "l"; /** * The Sketch widget's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#state Read more...} */ readonly state: "ready" | "disabled" | "active"; /** * Controls the appearance of the sketch widget, allowing * the toolbar to adapt its appearance appropriately based on context. * * @default "floating" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#toolbarKind Read more...} */ toolbarKind: "docked" | "floating"; /** * An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Graphic.html graphics} that are being updated by the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#updateGraphics Read more...} */ readonly updateGraphics: Collection; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Sketch widget provides a simple UI for creating and updating graphics on a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html Read more...} */ constructor(properties?: SketchProperties); /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#labelOptions Read more...} */ get labelOptions(): SketchLabelOptions; set labelOptions(value: SketchLabelOptionsProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#tooltipOptions Read more...} */ get tooltipOptions(): SketchTooltipOptions; set tooltipOptions(value: SketchTooltipOptionsProperties); /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#valueOptions Read more...} */ get valueOptions(): SketchValueOptions; set valueOptions(value: SketchValueOptionsProperties); /** * The view model for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#viewModel Read more...} */ get viewModel(): SketchViewModel; set viewModel(value: SketchViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#visibleElements Read more...} */ get visibleElements(): SketchVisibleElements; set visibleElements(value: SketchVisibleElementsProperties); /** * Cancels the active operation and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-create create} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#cancel Read more...} */ cancel(): void; /** * Completes the active operation and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-create create} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event * and changes the event's state to `complete`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#complete Read more...} */ complete(): void; /** * Create a graphic with the geometry specified in the `tool` parameter. * * @param tool Name of the create tool. Specifies the geometry for the graphic to be created. * @param createOptions Options for the graphic to be created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#create Read more...} */ create(tool: "point" | "polyline" | "polygon" | "rectangle" | "circle", createOptions?: SketchCreateCreateOptions): Promise; /** * Deletes the selected graphics used in the update workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#delete Read more...} */ delete(): void; /** * Duplicates current graphics used in the update workflow and automatically adds them * to the associated layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#duplicate Read more...} */ duplicate(): void; /** * Incrementally redo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#redo Read more...} */ redo(): void; /** * Incrementally undo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#undo Read more...} */ undo(): void; /** * Initializes an update operation for the specified graphic(s) and fires {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event. * * @param graphics A graphic or an array of graphics to be updated. Only graphics added to SketchViewModel's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#layer layer} property can be updated. * @param updateOptions Update options for the graphics to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#update Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#availableCreateTools Read more...} */ availableCreateTools?: | ( | "point" | "polyline" | "polygon" | "rectangle" | "circle" | "multipoint" | "freehandPolyline" | "freehandPolygon" | "mesh" )[] | nullish; /** * Defines the default behavior once the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#create create} operation is completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#creationMode Read more...} */ creationMode?: "single" | "continuous" | "update"; /** * Default create options set for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#defaultCreateOptions Read more...} */ defaultCreateOptions?: SketchDefaultCreateOptions; /** * Default update options set for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#defaultUpdateOptions Read more...} */ defaultUpdateOptions?: SketchDefaultUpdateOptions; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#icon Read more...} */ icon?: string; /** * The Sketch widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#label Read more...} */ label?: string; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#labelOptions Read more...} */ labelOptions?: SketchLabelOptionsProperties; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} associated with the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#layer Read more...} */ layer?: GraphicsLayer; /** * Determines the layout/orientation of the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#layout Read more...} */ layout?: "vertical" | "horizontal"; /** * Determines the size of widget elements. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#scale Read more...} */ scale?: "s" | "m" | "l"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Controls the appearance of the sketch widget, allowing * the toolbar to adapt its appearance appropriately based on context. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#toolbarKind Read more...} */ toolbarKind?: "docked" | "floating"; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#tooltipOptions Read more...} */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#valueOptions Read more...} */ valueOptions?: SketchValueOptionsProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for the Sketch widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#viewModel Read more...} */ viewModel?: SketchViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#visibleElements Read more...} */ visibleElements?: SketchVisibleElementsProperties; } export interface SketchViewModel extends Accessor, Evented { } export class SketchViewModel { /** * When creating new graphics (for example after {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#create create()} has been called), * this property reflects the drawing mode being used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeCreateToolDrawMode Read more...} */ readonly activeCreateToolDrawMode: "freehand" | "hybrid" | "click" | nullish; /** * When creating new graphics (for example after {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#create create()} has been called), * this property reflects the create tool being used. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTool Read more...} */ readonly activeTool: | "point" | "multipoint" | "polyline" | "polygon" | "circle" | "mesh" | "rectangle" | "freehandPolygon" | "freehandPolyline" | "move" | "transform" | "reshape" | nullish; /** * The tooltip currently being displayed for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTool activeTool}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTooltip Read more...} */ readonly activeTooltip: Tooltip | nullish; /** * The graphic that is being created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#createGraphic Read more...} */ readonly createGraphic: Graphic | nullish; /** * Defines the default behavior once the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#create create} operation is completed. * * @default "single" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#creationMode Read more...} */ creationMode: "single" | "continuous" | "update"; /** * Default create options set for the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#defaultCreateOptions Read more...} */ defaultCreateOptions: SketchViewModelDefaultCreateOptions; /** * Default update options set for the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions Read more...} */ defaultUpdateOptions: SketchViewModelDefaultUpdateOptions; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} associated with the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#layer Read more...} */ layer: GraphicsLayer; /** * The sketch view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#state Read more...} */ readonly state: "ready" | "disabled" | "active"; /** * An array of graphics that are being updated by the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#updateGraphics Read more...} */ readonly updateGraphics: Collection; /** * Indicates if a graphic can be selected to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#updateOnGraphicClick Read more...} */ updateOnGraphicClick: boolean; /** * The view in which geometries will be sketched by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html Sketch} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-sketch/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html Read more...} */ constructor(properties?: SketchViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol} displayed when actively creating a new `polygon` graphic using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTool `polygon`} tool. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeFillSymbol Read more...} */ get activeFillSymbol(): SimpleFillSymbol | CIMSymbol | nullish; set activeFillSymbol(value: (SimpleFillSymbolProperties & { type: "simple-fill" }) | (CIMSymbolProperties & { type: "cim" }) | nullish); /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#labelOptions Read more...} */ get labelOptions(): SketchLabelOptions; set labelOptions(value: SketchLabelOptionsProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html PointSymbol3D}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html TextSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html WebStyleSymbol} used for representing the point geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#pointSymbol Read more...} */ get pointSymbol(): | SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol; set pointSymbol(value: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" })); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html PolygonSymbol3D}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the polygon geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#polygonSymbol Read more...} */ get polygonSymbol(): SimpleFillSymbol | PolygonSymbol3D | CIMSymbol; set polygonSymbol(value: | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" })); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html LineSymbol3D}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the polyline geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#polylineSymbol Read more...} */ get polylineSymbol(): SimpleLineSymbol | LineSymbol3D | CIMSymbol; set polylineSymbol(value: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" })); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#tooltipOptions Read more...} */ get tooltipOptions(): SketchTooltipOptions; set tooltipOptions(value: SketchTooltipOptionsProperties); /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#valueOptions Read more...} */ get valueOptions(): SketchValueOptions; set valueOptions(value: SketchValueOptionsProperties); /** * Cancels the active operation and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#event-create create} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#event-update update} event * If called in the middle of a create operation, `cancel()` discards the partially created graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#cancel Read more...} */ cancel(): void; /** * Indicates if it is possible to perform a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#redo redo()} action in the current update session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#canRedo Read more...} */ canRedo(): boolean; /** * Indicates if it is possible to perform an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#undo undo()} action in the current update session. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#canUndo Read more...} */ canUndo(): boolean; /** * Completes the active operation and fires the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#event-create create} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#event-update update} event * and changes the event's state to `complete`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#complete Read more...} */ complete(): void; /** * Create a graphic with the geometry specified in the `tool` parameter. * * @param tool Name of the create tool. Specifies the geometry for the graphic to be created. * @param createOptions Options for the graphic to be created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#create Read more...} */ create(tool: | "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh" | "freehandPolygon" | "freehandPolyline", createOptions?: SketchViewModelCreateCreateOptions): void; /** * Deletes the selected graphics used in the update workflow. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#delete Read more...} */ delete(): void; /** * Duplicates current graphics used in the update workflow and automatically adds them * to the associated layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#duplicate Read more...} */ duplicate(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Allows creation of a graphic similar to create with the * difference that the geometry can be provided directly for the graphic being created. * * @param geometry Geometry to place when creating the graphic. Currently only {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-geometry-Mesh.html mesh} geometry is supported. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#place Read more...} */ place(geometry: Mesh): void; /** * Incrementally redo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#redo Read more...} */ redo(): void; /** * Incrementally undo actions recorded in the stack. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#undo Read more...} */ undo(): void; /** * Initializes an update operation for the specified graphic(s) and fires {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#event-update update} event. * * @param graphics A graphic or an array of graphics to be updated. Only graphics added to SketchViewModel's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#layer layer} property can be updated. * @param updateOptions Update options for the graphics to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#update Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol} displayed when actively creating a new `polygon` graphic using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeTool `polygon`} tool. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#activeFillSymbol Read more...} */ activeFillSymbol?: | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (CIMSymbolProperties & { type: "cim" }) | nullish; /** * Defines the default behavior once the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#create create} operation is completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#creationMode Read more...} */ creationMode?: "single" | "continuous" | "update"; /** * Default create options set for the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#defaultCreateOptions Read more...} */ defaultCreateOptions?: SketchViewModelDefaultCreateOptions; /** * Default update options set for the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#defaultUpdateOptions Read more...} */ defaultUpdateOptions?: SketchViewModelDefaultUpdateOptions; /** * Options to configure the sketch labels shown next to each segment of the geometry being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#labelOptions Read more...} */ labelOptions?: SketchLabelOptionsProperties; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-GraphicsLayer.html GraphicsLayer} associated with the SketchViewModel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#layer Read more...} */ layer?: GraphicsLayer; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleMarkerSymbol.html SimpleMarkerSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PointSymbol3D.html PointSymbol3D}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-TextSymbol.html TextSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-WebStyleSymbol.html WebStyleSymbol} used for representing the point geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#pointSymbol Read more...} */ pointSymbol?: | (SimpleMarkerSymbolProperties & { type: "simple-marker" }) | (PictureMarkerSymbolProperties & { type: "picture-marker" }) | (PointSymbol3DProperties & { type: "point-3d" }) | (TextSymbolProperties & { type: "text" }) | (CIMSymbolProperties & { type: "cim" }) | (WebStyleSymbolProperties & { type: "web-style" }); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleFillSymbol.html SimpleFillSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-PolygonSymbol3D.html PolygonSymbol3D}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the polygon geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#polygonSymbol Read more...} */ polygonSymbol?: | (SimpleFillSymbolProperties & { type: "simple-fill" }) | (PolygonSymbol3DProperties & { type: "polygon-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol}, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-LineSymbol3D.html LineSymbol3D}, or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-CIMSymbol.html CIMSymbol} used for representing the polyline geometry that is being drawn. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#polylineSymbol Read more...} */ polylineSymbol?: | (SimpleLineSymbolProperties & { type: "simple-line" }) | (LineSymbol3DProperties & { type: "line-3d" }) | (CIMSymbolProperties & { type: "cim" }); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * Options to configure the tooltip shown next to the cursor when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#tooltipOptions Read more...} */ tooltipOptions?: SketchTooltipOptionsProperties; /** * Indicates if a graphic can be selected to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#updateOnGraphicClick Read more...} */ updateOnGraphicClick?: boolean; /** * Options to configure how values are displayed and input when creating or updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#valueOptions Read more...} */ valueOptions?: SketchValueOptionsProperties; /** * The view in which geometries will be sketched by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch-SketchViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } export interface SketchViewModelCreateEvent { graphic: Graphic; state: "start" | "active" | "complete" | "cancel"; tool: | "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh" | "freehandPolyline" | "freehandPolygon"; 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" | "freehandPolyline" | "freehandPolygon" | "move" | "transform" | "reshape"; type: "redo"; } export interface SketchViewModelCreateCreateOptions { defaultZ?: number; hasZ?: boolean; mode?: "hybrid" | "freehand" | "click"; preserveAspectRatio?: boolean; } export interface SketchViewModelDefaultCreateOptions { defaultZ?: number; hasZ?: boolean; mode?: "hybrid" | "freehand" | "click"; preserveAspectRatio?: boolean; } export interface SketchViewModelDefaultUpdateOptions { tool?: "move" | "transform" | "reshape"; enableRotation?: boolean; enableScaling?: boolean; enableZ?: boolean; multipleSelectionEnabled?: boolean; preserveAspectRatio?: boolean; toggleToolOnClick?: boolean; reshapeOptions?: SketchViewModelDefaultUpdateOptionsReshapeOptions; highlightOptions?: SketchViewModelDefaultUpdateOptionsHighlightOptions; } export interface SketchViewModelDefaultUpdateOptionsHighlightOptions { enabled?: boolean; name?: string; } export interface SketchViewModelDefaultUpdateOptionsReshapeOptions { edgeOperation?: "none" | "split" | "offset"; shapeOperation?: "none" | "move" | "move-xy"; vertexOperation?: "move" | "move-xy"; } export interface SketchViewModelUpdateUpdateOptions { tool?: "transform" | "reshape" | "move"; enableRotation?: boolean; enableScaling?: boolean; enableZ?: boolean; multipleSelectionEnabled?: boolean; preserveAspectRatio?: boolean; toggleToolOnClick?: boolean; } export interface SketchViewModelUndoEvent { graphics: Graphic[]; tool: | "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh" | "freehandPolyline" | "freehandPolygon" | "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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-create create} event when the graphic * is being created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#CreateToolEventInfo Read more...} */ export type CreateToolEventInfo = VertexAddEventInfo | CursorUpdateEventInfo; /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-create create} * event when the user moves the cursor on the view while the graphic is being created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#CursorUpdateEventInfo Read more...} */ export interface CursorUpdateEventInfo { type: "cursor-update"; coordinates: number[]; } export interface SketchDeleteEvent { graphics: Graphic[]; tool: "move" | "reshape" | "transform"; type: "delete"; } /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} * event while the user is moving the graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#MoveEventInfo Read more...} */ export interface MoveEventInfo { type: "move-start" | "move" | "move-stop"; dx: number; dy: number; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} * event while the user is reshaping the graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#ReshapeEventInfo Read more...} */ export interface ReshapeEventInfo { type: "reshape-start" | "reshape" | "reshape-stop"; } /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} * event while the user is rotating the graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#RotateEventInfo Read more...} */ export interface RotateEventInfo { type: "rotate-start" | "rotate" | "rotate-stop"; angle: number; } /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} * event while the user is scaling or resizing the graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#ScaleEventInfo Read more...} */ export interface ScaleEventInfo { type: "scale-start" | "scale" | "scale-stop"; xScale: number; yScale: number; } /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} * event while the user is selecting or deselecting graphics using `Shift+Left-click`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#SelectionChangeEventInfo Read more...} */ export interface SelectionChangeEventInfo { type: "selection-change"; added: Graphic[]; removed: Graphic[]; } export interface SketchCreateCreateOptions { defaultZ?: number; hasZ?: boolean; mode?: "hybrid" | "freehand" | "click"; preserveAspectRatio?: boolean; } export interface SketchDefaultCreateOptions { defaultZ?: number; hasZ?: boolean; mode?: "hybrid" | "freehand" | "click"; preserveAspectRatio?: boolean; } export interface SketchDefaultUpdateOptions { tool?: "move" | "transform" | "reshape"; enableRotation?: boolean; enableScaling?: boolean; enableZ?: boolean; multipleSelectionEnabled?: boolean; preserveAspectRatio?: boolean; toggleToolOnClick?: boolean; reshapeOptions?: SketchDefaultUpdateOptionsReshapeOptions; highlightOptions?: SketchDefaultUpdateOptionsHighlightOptions; } export interface SketchDefaultUpdateOptionsHighlightOptions { enabled?: boolean; } export interface SketchDefaultUpdateOptionsReshapeOptions { edgeOperation?: "none" | "split" | "offset"; shapeOperation?: "none" | "move" | "move-xy"; vertexOperation?: "move" | "move-xy"; } export interface SketchUpdateUpdateOptions { tool?: "transform" | "reshape" | "move"; enableRotation?: boolean; enableScaling?: boolean; enableZ?: boolean; multipleSelectionEnabled?: boolean; preserveAspectRatio?: boolean; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event when the user is updating graphics. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#UpdateToolEventInfo Read more...} */ export type UpdateToolEventInfo = | MoveEventInfo | ReshapeEventInfo | RotateEventInfo | ScaleEventInfo | SelectionChangeEventInfo | VertexAddEventInfo | VertexRemoveEventInfo; /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-create create} * or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event when the user adds vertices to the graphic being created or updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#VertexAddEventInfo Read more...} */ export interface VertexAddEventInfo { type: "vertex-add"; added: number[]; vertices: VertexAddEventInfoVertices[]; } /** * This information is returned as `toolEventInfo` parameter for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#event-update update} event * when the user is removing vertices from the graphic. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#VertexRemoveEventInfo Read more...} */ export interface VertexRemoveEventInfo { type: "vertex-remove"; removed: number[]; vertices: VertexRemoveEventInfoVertices[]; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#VisibleElements Read more...} */ export interface SketchVisibleElementsProperties { createTools?: VisibleElementsCreateToolsProperties; duplicateButton?: boolean; deleteButton?: boolean; selectionCountLabel?: boolean; selectionTools?: VisibleElementsSelectionToolsProperties; settingsMenu?: boolean; labelsToggle?: boolean; tooltipsToggle?: boolean; snappingControls?: boolean; snappingControlsElements?: SketchVisibleElementsSnappingControlsElementsProperties; undoRedoMenu?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Sketch.html#VisibleElements Read more...} */ export interface SketchVisibleElements extends AnonymousAccessor { get createTools(): VisibleElementsCreateTools; set createTools(value: VisibleElementsCreateToolsProperties); get selectionTools(): VisibleElementsSelectionTools; set selectionTools(value: VisibleElementsSelectionToolsProperties); get snappingControlsElements(): SketchVisibleElementsSnappingControlsElements; set snappingControlsElements(value: SketchVisibleElementsSnappingControlsElementsProperties); duplicateButton: boolean; deleteButton: boolean; selectionCountLabel: boolean; settingsMenu: boolean; labelsToggle: boolean; tooltipsToggle: boolean; snappingControls: boolean; undoRedoMenu: boolean; } export interface VertexAddEventInfoVertices { coordinates: number[]; componentIndex: number; vertexIndex: number; } export interface VertexRemoveEventInfoVertices { coordinates: number[]; componentIndex: number; vertexIndex: number; } export interface VisibleElementsCreateToolsProperties { point?: boolean; polyline?: boolean; polygon?: boolean; rectangle?: boolean; circle?: boolean; freehandPolyline?: boolean; freehandPolygon?: boolean; } export interface VisibleElementsCreateTools extends AnonymousAccessor { point: boolean; polyline: boolean; polygon: boolean; rectangle: boolean; circle: boolean; freehandPolyline: boolean; freehandPolygon: boolean; } export interface VisibleElementsSelectionToolsProperties { "rectangle-selection"?: boolean; "lasso-selection"?: boolean; } export interface VisibleElementsSelectionTools extends AnonymousAccessor { "rectangle-selection": boolean; "lasso-selection": boolean; } export interface SketchVisibleElementsSnappingControlsElementsProperties { header?: boolean; enabledToggle?: boolean; selfEnabledToggle?: boolean; featureEnabledToggle?: boolean; layerList?: boolean; layerListToggleLayersButton?: boolean; gridEnabledToggle?: boolean; gridControls?: boolean; gridControlsElements?: SketchVisibleElementsSnappingControlsElementsGridControlsElementsProperties; } export interface SketchVisibleElementsSnappingControlsElements extends AnonymousAccessor { get gridControlsElements(): SketchVisibleElementsSnappingControlsElementsGridControlsElements; set gridControlsElements(value: SketchVisibleElementsSnappingControlsElementsGridControlsElementsProperties); header: boolean; enabledToggle: boolean; selfEnabledToggle: boolean; featureEnabledToggle: boolean; layerList: boolean; layerListToggleLayersButton: boolean; gridEnabledToggle: boolean; gridControls: boolean; } export interface SketchVisibleElementsSnappingControlsElementsGridControlsElementsProperties { gridSnapEnabledToggle?: boolean; gridEnabledToggle?: boolean; colorSelection?: boolean; dynamicScaleToggle?: boolean; rotateWithMapToggle?: boolean; numericInputs?: boolean; lineIntervalInput?: boolean; placementButtons?: boolean; outOfScaleWarning?: boolean; } export interface SketchVisibleElementsSnappingControlsElementsGridControlsElements extends AnonymousAccessor { gridSnapEnabledToggle: boolean; gridEnabledToggle: boolean; colorSelection: boolean; dynamicScaleToggle: boolean; rotateWithMapToggle: boolean; numericInputs: boolean; lineIntervalInput: boolean; placementButtons: boolean; outOfScaleWarning: boolean; } export class Slice extends Widget { /** * Indicates the heading level to use for the "Excluded layers" heading. * * @default 3 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "slice" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#view Read more...} */ view: SceneView | nullish; /** * The Slice widget is a 3D analysis tool that can be used to reveal occluded content in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html Read more...} */ constructor(properties?: SliceProperties); /** * The slice analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#analysis Read more...} */ get analysis(): SliceAnalysis; set analysis(value: SliceAnalysisProperties & { type: "slice" }); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#viewModel Read more...} */ get viewModel(): SliceViewModel; set viewModel(value: SliceViewModelProperties); } interface SliceProperties extends WidgetProperties { /** * The slice analysis object being created or modified by the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#analysis Read more...} */ analysis?: SliceAnalysisProperties & { type: "slice" }; /** * Indicates the heading level to use for the "Excluded layers" heading. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html#viewModel Read more...} */ viewModel?: SliceViewModelProperties; } export class SliceViewModel extends Accessor { /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html Ground} and layers that * are draped on the ground surface are excluded from the slice. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#excludeGroundSurface Read more...} */ excludeGroundSurface: boolean; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "slicing" | "sliced"; /** * Enable tilting the slice shape. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#tiltEnabled Read more...} */ tiltEnabled: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice.html Slice} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-slice/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html Read more...} */ constructor(properties?: SliceViewModelProperties); /** * The slice analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#analysis Read more...} */ get analysis(): SliceAnalysis; set analysis(value: SliceAnalysisProperties & { type: "slice" }); /** * Add layers to this collection to exclude them from the slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#excludedLayers Read more...} */ get excludedLayers(): Collection; set excludedLayers(value: CollectionProperties); /** * The shape used to slice elements in a 3D scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#shape Read more...} */ get shape(): SlicePlane | nullish; set shape(value: (SlicePlaneProperties & { type: "plane" }) | nullish); /** * Clears the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#shape shape} of the slice, effectively removing it from the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#clear Read more...} */ clear(): void; /** * Starts the interactive creation of a new slice, clearing the previous {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#shape shape}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#start Read more...} */ start(): void; } interface SliceViewModelProperties { /** * The slice analysis object being created or modified by the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#analysis Read more...} */ analysis?: SliceAnalysisProperties & { type: "slice" }; /** * Add layers to this collection to exclude them from the slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#excludedLayers Read more...} */ excludedLayers?: CollectionProperties; /** * Indicates whether the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Ground.html Ground} and layers that * are draped on the ground surface are excluded from the slice. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#excludeGroundSurface Read more...} */ excludeGroundSurface?: boolean; /** * The shape used to slice elements in a 3D scene. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#shape Read more...} */ shape?: (SlicePlaneProperties & { type: "plane" }) | nullish; /** * Enable tilting the slice shape. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#tiltEnabled Read more...} */ tiltEnabled?: boolean; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slice-SliceViewModel.html#view Read more...} */ view?: SceneView | nullish; } export class Slider extends Widget { /** * When `true`, sets the slider to a disabled state so the user cannot interact * with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#disabled Read more...} */ disabled: boolean; /** * Indicates if the user can drag the segment between thumbs * to update thumb positions. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#draggableSegmentsEnabled Read more...} */ draggableSegmentsEnabled: boolean; /** * When set, the user is restricted from moving slider thumbs to positions higher than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMax Read more...} */ effectiveMax: number | nullish; /** * When set, the user is restricted from moving slider thumbs to positions less than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMin Read more...} */ effectiveMin: number | nullish; /** * The HTML Element nodes representing the slider segment between the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min min} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMin effectiveMin}, and the segment between the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMax effectiveMax} and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max max}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveSegmentElements Read more...} */ readonly effectiveSegmentElements: Collection; /** * Icon displayed in the widget's button. * * @default "caret-double-horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#icon Read more...} */ icon: string; /** * A function that provides the developer with access to the input elements when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#rangeLabelInputsEnabled rangeLabelInputsEnabled} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelInputsEnabled labelInputsEnabled} are set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputCreatedFunction Read more...} */ inputCreatedFunction: InputCreatedFunction | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputFormatFunction Read more...} */ inputFormatFunction: SliderLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputParseFunction Read more...} */ inputParseFunction: InputParser | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#label Read more...} */ label: string; /** * The HTML Element nodes representing {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labels labels} attached to slider thumbs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelElements Read more...} */ readonly labelElements: Collection; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelFormatFunction Read more...} */ labelFormatFunction: SliderLabelFormatter | nullish; /** * Indicates whether to enable editing input values via keyboard input * when the user clicks a label. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelInputsEnabled Read more...} */ labelInputsEnabled: boolean; /** * An array of strings associated with 'values' generated using an internal label formatter or * the values returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelFormatFunction labelFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labels Read more...} */ readonly labels: LabelInfos; /** * Determines the layout/orientation of the Slider widget. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#layout Read more...} */ layout: "horizontal" | "horizontal-reversed" | "vertical" | "vertical-reversed"; /** * The maximum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max Read more...} */ max: number | nullish; /** * The HTML Element node representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max max} value label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#maxLabelElement Read more...} */ readonly maxLabelElement: HTMLElement | nullish; /** * The minimum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min Read more...} */ min: number | nullish; /** * The HTML Element node representing the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min min} value label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#minLabelElement Read more...} */ readonly minLabelElement: HTMLElement | nullish; /** * Defines how slider thumb values should be rounded. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#precision Read more...} */ precision: number; /** * Indicates whether to enable editing range values via keyboard input * when the user clicks a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min min} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max max} label. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#rangeLabelInputsEnabled Read more...} */ rangeLabelInputsEnabled: boolean; /** * The HTML Element nodes representing interactive slider segments. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#segmentElements Read more...} */ readonly segmentElements: Collection; /** * Indicates if the closest thumb will snap to the clicked location on the track. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#snapOnClickEnabled Read more...} */ snapOnClickEnabled: boolean; /** * The current state of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#state Read more...} */ readonly state: "ready" | "disabled" | "editing" | "dragging"; /** * Sets steps, or intervals, on the slider that restrict user * input to specific values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#steps Read more...} */ steps: number | number[] | nullish; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#syncedSegmentsEnabled Read more...} */ syncedSegmentsEnabled: boolean; /** * Function that executes each time a thumb is created on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#thumbCreatedFunction Read more...} */ thumbCreatedFunction: ThumbCreatedFunction | nullish; /** * The HTML Element nodes representing slider thumbs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#thumbElements Read more...} */ readonly thumbElements: Collection; /** * When `false`, the user can freely move any slider thumb to any * position along the track. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#thumbsConstrained Read more...} */ thumbsConstrained: boolean; /** * When set, renders ticks along the slider track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#tickConfigs Read more...} */ tickConfigs: TickConfig[]; /** * The HTML Element nodes representing slider ticks and their associated labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#tickElements Read more...} */ readonly tickElements: Collection>; /** * The HTML Element node representing the slider track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#trackElement Read more...} */ readonly trackElement: HTMLElement | nullish; /** * An array of numbers representing absolute thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#values Read more...} */ values: number[] | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#visibleElements Read more...} */ visibleElements: SliderVisibleElements; /** * A slider widget that can be used for filtering data, or gathering * numeric input from a user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html Read more...} */ constructor(properties?: SliderProperties); /** * The view model for the Slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#viewModel Read more...} */ get viewModel(): SliderViewModel; set viewModel(value: SliderViewModelProperties); 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#disabled Read more...} */ disabled?: boolean; /** * Indicates if the user can drag the segment between thumbs * to update thumb positions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#draggableSegmentsEnabled Read more...} */ draggableSegmentsEnabled?: boolean; /** * When set, the user is restricted from moving slider thumbs to positions higher than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMax Read more...} */ effectiveMax?: number | nullish; /** * When set, the user is restricted from moving slider thumbs to positions less than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#effectiveMin Read more...} */ effectiveMin?: number | nullish; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#icon Read more...} */ icon?: string; /** * A function that provides the developer with access to the input elements when * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#rangeLabelInputsEnabled rangeLabelInputsEnabled} and/or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelInputsEnabled labelInputsEnabled} are set to `true`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputCreatedFunction Read more...} */ inputCreatedFunction?: InputCreatedFunction | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputFormatFunction Read more...} */ inputFormatFunction?: SliderLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#inputParseFunction Read more...} */ inputParseFunction?: InputParser | nullish; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#label Read more...} */ label?: string; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelFormatFunction Read more...} */ labelFormatFunction?: SliderLabelFormatter | nullish; /** * Indicates whether to enable editing input values via keyboard input * when the user clicks a label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelInputsEnabled Read more...} */ labelInputsEnabled?: boolean; /** * Determines the layout/orientation of the Slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#layout Read more...} */ layout?: "horizontal" | "horizontal-reversed" | "vertical" | "vertical-reversed"; /** * The maximum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max Read more...} */ max?: number | nullish; /** * The minimum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min Read more...} */ min?: number | nullish; /** * Defines how slider thumb values should be rounded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#precision Read more...} */ precision?: number; /** * Indicates whether to enable editing range values via keyboard input * when the user clicks a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#min min} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#max max} label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#rangeLabelInputsEnabled Read more...} */ rangeLabelInputsEnabled?: boolean; /** * Indicates if the closest thumb will snap to the clicked location on the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#snapOnClickEnabled Read more...} */ snapOnClickEnabled?: boolean; /** * Sets steps, or intervals, on the slider that restrict user * input to specific values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#steps Read more...} */ steps?: number | number[] | nullish; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#syncedSegmentsEnabled Read more...} */ syncedSegmentsEnabled?: boolean; /** * Function that executes each time a thumb is created on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#thumbCreatedFunction Read more...} */ thumbCreatedFunction?: ThumbCreatedFunction | nullish; /** * When `false`, the user can freely move any slider thumb to any * position along the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#thumbsConstrained Read more...} */ thumbsConstrained?: boolean; /** * When set, renders ticks along the slider track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#tickConfigs Read more...} */ tickConfigs?: TickConfig[]; /** * An array of numbers representing absolute thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#values Read more...} */ values?: number[] | nullish; /** * The view model for the Slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#viewModel Read more...} */ viewModel?: SliderViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#visibleElements Read more...} */ visibleElements?: SliderVisibleElements; } export class SliderViewModel extends Accessor { /** * When set, the user is restricted from moving slider thumbs to positions higher than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#effectiveMax Read more...} */ effectiveMax: number | nullish; /** * When set, the user is restricted from moving slider thumbs to positions less than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#effectiveMin Read more...} */ effectiveMin: number | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputFormatFunction Read more...} */ inputFormatFunction: SliderLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputParseFunction Read more...} */ inputParseFunction: InputParser | nullish; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction: SliderLabelFormatter | nullish; /** * An array of strings associated with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#values values} generated using an internal label formatter or * the values returned from {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction labelFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labels Read more...} */ readonly labels: LabelInfos; /** * The maximum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#max Read more...} */ max: number | nullish; /** * The minimum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#min Read more...} */ min: number | nullish; /** * Defines how slider values should be rounded. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#precision Read more...} */ precision: number; /** * The state of the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * When `false`, the user can freely move any slider thumb to any * position along the track. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#thumbsConstrained Read more...} */ thumbsConstrained: boolean; /** * An array of numbers representing absolute thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#values Read more...} */ values: number[] | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html Slider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html Read more...} */ constructor(properties?: SliderViewModelProperties); /** * The default input format function available for use as a fallback in custom formatting implementations. * * @param value The input value to format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#defaultInputFormatFunction Read more...} */ defaultInputFormatFunction(value: number): string; /** * The default input parsing function available for use as a fallback in custom parsing implementations. * * @param value The thumb value to parse. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#defaultInputParseFunction Read more...} */ defaultInputParseFunction(value: string): number; /** * The default label format function, available for use as a fallback in custom formatting implementations. * * @param value The thumb value to format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#defaultLabelFormatFunction Read more...} */ defaultLabelFormatFunction(value: number): string; /** * Returns the effective bounds of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#getBounds Read more...} */ getBounds(): Bounds; /** * Returns the min and max bounds for a 'value' at the provided index. * * @param index The index of the associated value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#getBoundsForValueAtIndex Read more...} */ getBoundsForValueAtIndex(index: number): any; /** * Returns the formatted label for a provided value. * * @param value The value from which to retrieve a formatted label. * @param type The label type. * @param index The index of the label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#getLabelForValue Read more...} */ getLabelForValue(value: number | nullish, type?: "min" | "max" | "tick" | "value", index?: number): string | nullish; /** * Updates a thumb {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#values value} based on the provided index. * * @param index The index of the thumb value in the associated {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#values values} array. * @param value The new value to replace with the old value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#setValue Read more...} */ setValue(index: number, value: number): void; /** * Rounds the given value to the number of decimal places specified in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#precision precision} property set on the view model. * * @param value The thumb value to format. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#toPrecision Read more...} */ toPrecision(value: number): number; } interface SliderViewModelProperties { /** * When set, the user is restricted from moving slider thumbs to positions higher than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#effectiveMax Read more...} */ effectiveMax?: number | nullish; /** * When set, the user is restricted from moving slider thumbs to positions less than * this value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#effectiveMin Read more...} */ effectiveMin?: number | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputFormatFunction Read more...} */ inputFormatFunction?: SliderLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#inputParseFunction Read more...} */ inputParseFunction?: InputParser | nullish; /** * A function used to format labels. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction?: SliderLabelFormatter | nullish; /** * The maximum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#max Read more...} */ max?: number | nullish; /** * The minimum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#min Read more...} */ min?: number | nullish; /** * Defines how slider values should be rounded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#precision Read more...} */ precision?: number; /** * When `false`, the user can freely move any slider thumb to any * position along the track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#thumbsConstrained Read more...} */ thumbsConstrained?: boolean; /** * An array of numbers representing absolute thumb positions on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#values Read more...} */ values?: number[] | nullish; } /** * Represents the effective bounds of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#Bounds Read more...} */ export interface Bounds { min: number | nullish; max: number | nullish; } 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; /** * Label infos for the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#LabelInfos Read more...} */ export interface LabelInfos { min: string | nullish; max: string | nullish; values: (string | nullish)[]; } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#TickConfig Read more...} */ export interface TickConfig { mode: "percent" | "position" | "count" | "step"; values: number | number[]; labelsVisible?: boolean; tickCreatedFunction?: TickCreatedFunction; labelFormatFunction?: SliderLabelFormatter; } export type TickCreatedFunction = ( value: number, tickElement?: HTMLElement | nullish, labelElement?: HTMLElement | nullish, ) => void; /** * The HTML Element nodes representing a single slider tick and its associated label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#TickElementGroup Read more...} */ export interface TickElementGroup { tickElement?: HTMLElement | nullish; labelElement?: HTMLElement | nullish; } export interface SliderTrackClickEvent { type: "track-click"; value: number; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#VisibleElements Read more...} */ export interface SliderVisibleElements { labels?: boolean; 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#label Read more...} */ label: string; /** * 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#stops Read more...} */ stops: SizeStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#style Read more...} */ style: BinaryColorSizeSliderStyle; /** * 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html Read more...} */ constructor(properties?: BinaryColorSizeSliderProperties); /** * The view model for the BinaryColorSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#viewModel Read more...} */ get viewModel(): BinaryColorSizeSliderViewModel; set viewModel(value: BinaryColorSizeSliderViewModelProperties); /** * A convenience function used to update the properties of a BinaryColorSizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update the input renderer based on * the values of the slider {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#stops stops}. * * @param renderer The renderer to update from the slider values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#updateRenderer Read more...} */ updateRenderer(renderer: ClassBreaksRenderer): ClassBreaksRenderer | nullish; /** * A convenience function used to create a BinaryColorSizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#fromRendererResult Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#label Read more...} */ label?: string; /** * When `true`, ensures symbol sizes in the `above` range * are consistent with symbol sizes in the `below` range for all slider thumb positions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled?: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#stops Read more...} */ stops?: SizeStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#style Read more...} */ style?: BinaryColorSizeSliderStyle; /** * The view model for the BinaryColorSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html#viewModel Read more...} */ viewModel?: BinaryColorSizeSliderViewModelProperties; } export class BinaryColorSizeSliderViewModel extends SizeSliderViewModel { /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider.html BinaryColorSizeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-BinaryColorSizeSlider-BinaryColorSizeSliderViewModel.html Read more...} */ constructor(properties?: BinaryColorSizeSliderViewModelProperties); } interface BinaryColorSizeSliderViewModelProperties extends SizeSliderViewModelProperties { } export interface BinaryColorSizeSliderStyle { trackAboveFillColor?: Color; trackBelowFillColor?: Color; trackBackgroundColor?: Color; } export class ClassedColorSlider extends SmartMappingSliderBase { /** * An array of class breaks with associated colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#breaks Read more...} */ breaks: ClassedColorSliderBreaks[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#label Read more...} */ label: string; /** * The ClassedColorSlider widget is designed for authoring and exploring data-driven visualizations in any * layer that can be rendered with color in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html Read more...} */ constructor(properties?: ClassedColorSliderProperties); /** * The view model for the ClassedColorSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#viewModel Read more...} */ get viewModel(): ClassedColorSliderViewModel; set viewModel(value: ClassedColorSliderViewModelProperties); /** * A convenience function used to update the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfos} * of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} associated with this slider. * * @param breakInfos The classBreakInfos from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} instance to update based on the properties of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#updateClassBreakInfos Read more...} */ updateClassBreakInfos(breakInfos: ClassBreakInfo[]): ClassBreakInfo[] | nullish; /** * A convenience function used to update the properties a ClassedColorSlider from the result * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer createClassBreaksRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ClassedColorSlider widget from the result * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createClassBreaksRenderer createClassBreaksRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult Read more...} */ static fromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): ClassedColorSlider; } interface ClassedColorSliderProperties extends SmartMappingSliderBaseProperties { /** * An array of class breaks with associated colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#breaks Read more...} */ breaks?: ClassedColorSliderBreaks[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#label Read more...} */ label?: string; /** * The view model for the ClassedColorSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html#viewModel Read more...} */ viewModel?: ClassedColorSliderViewModelProperties; } export class ClassedColorSliderViewModel extends SmartMappingSliderViewModel { /** * An array of class breaks with associated colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks Read more...} */ breaks: ClassedColorSliderViewModelBreaks[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider.html ClassedColorSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html Read more...} */ constructor(properties?: ClassedColorSliderViewModelProperties); /** * Generates the color ramp rendered on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#getStopInfo Read more...} */ getStopInfo(): StopInfo[]; } interface ClassedColorSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * An array of class breaks with associated colors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#breaks Read more...} */ breaks?: ClassedColorSliderViewModelBreaks[]; } export interface ClassedColorSliderViewModelBreaks { color: Color; max: number; min: number; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#getStopInfo getStopInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedColorSlider-ClassedColorSliderViewModel.html#StopInfo Read more...} */ export interface StopInfo { color: Color; offset: number; } export interface ClassedColorSliderBreaks { color: Color; max: number; min: number; } export class ClassedSizeSlider extends SmartMappingSliderBase { /** * An array of class breaks with associated sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#breaks Read more...} */ breaks: ClassedSizeSliderBreaks[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#label Read more...} */ label: string; /** * Exposes various properties of the widget that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#style Read more...} */ style: ClassedSizeSliderStyle; /** * The ClassedSizeSlider widget is designed for authoring and exploring data-driven visualizations in any * layer that can be rendered with size in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html Read more...} */ constructor(properties?: ClassedSizeSliderProperties); /** * The view model for the ClassedSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#viewModel Read more...} */ get viewModel(): ClassedSizeSliderViewModel; set viewModel(value: ClassedSizeSliderViewModelProperties); /** * A convenience function used to update the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html#classBreakInfos classBreakInfos} * of a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} associated with this slider. * * @param breakInfos The classBreakInfos from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-ClassBreaksRenderer.html ClassBreaksRenderer} instance to update based on the properties of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#updateClassBreakInfos Read more...} */ updateClassBreakInfos(breakInfos: ClassBreakInfo[]): ClassBreakInfo[] | nullish; /** * A convenience function used to update the properties a ClassedSizeSlider from the result * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer createClassBreaksRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: sizeClassBreaksRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ClassedSizeSlider widget from the result * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer createClassBreaksRenderer()} method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createClassBreaksRenderer createClassBreaksRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult Read more...} */ static fromRendererResult(rendererResult: sizeClassBreaksRendererResult, histogramResult?: HistogramResult): ClassedSizeSlider; } interface ClassedSizeSliderProperties extends SmartMappingSliderBaseProperties { /** * An array of class breaks with associated sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#breaks Read more...} */ breaks?: ClassedSizeSliderBreaks[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#label Read more...} */ label?: string; /** * Exposes various properties of the widget that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#style Read more...} */ style?: ClassedSizeSliderStyle; /** * The view model for the ClassedSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html#viewModel Read more...} */ viewModel?: ClassedSizeSliderViewModelProperties; } export class ClassedSizeSliderViewModel extends SmartMappingSliderViewModel { /** * An array of class breaks with associated sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks Read more...} */ breaks: ClassedSizeSliderViewModelBreaks[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider.html ClassedSizeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html Read more...} */ constructor(properties?: ClassedSizeSliderViewModelProperties); } interface ClassedSizeSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * An array of class breaks with associated sizes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html#breaks Read more...} */ breaks?: ClassedSizeSliderViewModelBreaks[]; } export interface ClassedSizeSliderViewModelBreaks { size: number; max: number; min: number; } export interface ClassedSizeSliderBreaks { size: number; max: number; min: number; } export interface ClassedSizeSliderStyle { trackFillColor?: Color; trackBackgroundColor?: Color; } export class ColorSizeSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#label Read more...} */ label: string; /** * Only applicable when three thumbs (i.e. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled: boolean; /** * The colors and sizes corresponding with data values in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} of the renderer * associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#stops Read more...} */ stops: ColorSizeStop[]; /** * The ColorSizeSlider widget is intended for authoring and exploring data-driven visualizations in any * layer that can be rendered with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} and * a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html Read more...} */ constructor(properties?: ColorSizeSliderProperties); /** * The view model for the ColorSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#viewModel Read more...} */ get viewModel(): ColorSizeSliderViewModel; set viewModel(value: ColorSizeSliderViewModelProperties); /** * A convenience function used to update the properties of a ColorSizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer univariateColorSize.createContinuousRenderer()} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update a renderer generated with the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer univariateColorSize.createContinuousRenderer()} * method with the values obtained from the slider. * * @param renderer A renderer generated from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer univariateColorSize.createContinuousRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#updateRenderer Read more...} */ updateRenderer(renderer: ClassBreaksRenderer): ClassBreaksRenderer; /** * A convenience function used to update the visual variables of a renderer generated with the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer univariateColorSize.createContinuousRenderer()} * method with the values obtained from the slider. * * @param variables The visual variables to update from the renderer associated with the slider. The properties of the color and size variables will update based on the slider thumb values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#updateVisualVariables Read more...} */ updateVisualVariables(variables: (ColorVariable | SizeVariable)[]): (ColorVariable | SizeVariable)[]; /** * A convenience function used to create a ColorSizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer univariateColorSize.createContinuousRenderer()} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#fromRendererResult Read more...} */ static fromRendererResult(rendererResult: univariateColorSizeContinuousRendererResult, histogramResult?: HistogramResult): ColorSizeSlider; } interface ColorSizeSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#label Read more...} */ label?: string; /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled?: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled?: boolean; /** * The colors and sizes corresponding with data values in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} of the renderer * associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#stops Read more...} */ stops?: ColorSizeStop[]; /** * The view model for the ColorSizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html#viewModel Read more...} */ viewModel?: ColorSizeSliderViewModelProperties; } export class ColorSizeSliderViewModel extends SizeSliderViewModel { /** * The colors and sizes corresponding with data values in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} of the renderer * associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#stops Read more...} */ stops: ColorSizeStop[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider.html ColorSizeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html Read more...} */ constructor(properties?: ColorSizeSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#getStopInfo Read more...} */ getStopInfo(): ColorSizeSliderViewModelStopInfo[]; } interface ColorSizeSliderViewModelProperties extends SizeSliderViewModelProperties { /** * The colors and sizes corresponding with data values in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} and * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} of the renderer * associated with the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#stops Read more...} */ stops?: ColorSizeStop[]; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#getStopInfo getStopInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSizeSlider-ColorSizeSliderViewModel.html#StopInfo Read more...} */ export interface ColorSizeSliderViewModelStopInfo { color: Color; offset: number; } export class ColorSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#label Read more...} */ label: string; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled: boolean; /** * The color stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#stops Read more...} */ stops: ColorStop[]; /** * The ColorSlider widget is intended for authoring and exploring data-driven visualizations in any * layer that can be rendered with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html Read more...} */ constructor(properties?: ColorSliderProperties); /** * The view model for the ColorSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#viewModel Read more...} */ get viewModel(): ColorSliderViewModel; set viewModel(value: ColorSliderViewModelProperties); /** * A convenience function used to update the properties of a ColorSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create a ColorSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-color.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#fromRendererResult Read more...} */ static fromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): ColorSlider; } interface ColorSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#label Read more...} */ label?: string; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled?: boolean; /** * The color stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#stops Read more...} */ stops?: ColorStop[]; /** * The view model for the ColorSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html#viewModel Read more...} */ viewModel?: ColorSliderViewModelProperties; } export class ColorSliderViewModel extends SmartMappingPrimaryHandleSliderViewModel { /** * The color stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#stops Read more...} */ stops: ColorStop[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider.html ColorSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html Read more...} */ constructor(properties?: ColorSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider track. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#getStopInfo Read more...} */ getStopInfo(): ColorSliderViewModelStopInfo[]; } interface ColorSliderViewModelProperties extends SmartMappingPrimaryHandleSliderViewModelProperties { /** * The color stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-ColorVariable.html ColorVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#stops Read more...} */ stops?: ColorStop[]; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#getStopInfo getStopInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-ColorSlider-ColorSliderViewModel.html#StopInfo Read more...} */ export interface ColorSliderViewModelStopInfo { color: Color; offset: number; } export class HeatmapSlider extends Widget { /** * The HeatmapSlider widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#label Read more...} */ readonly label: string; /** * The colorStops * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} to associate with the * slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#stops Read more...} */ stops: HeatmapColorStop[]; /** * The HeatmapSlider widget is intended for authoring and exploring data-driven visualizations in any * layer that can be rendered with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html Read more...} */ constructor(properties?: HeatmapSliderProperties); /** * The view model for the Heatmap widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#viewModel Read more...} */ get viewModel(): HeatmapSliderViewModel; set viewModel(value: HeatmapSliderViewModelProperties); 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 * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#HeatmapRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#createRenderer heatmapRendererCreator.createRenderer()} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-heatmap.html#createRenderer heatmapRendererCreator.createRenderer()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#fromHeatmapRendererResult Read more...} */ static fromHeatmapRendererResult(rendererResult: HeatmapRendererResult): HeatmapSlider; } interface HeatmapSliderProperties extends WidgetProperties { /** * The colorStops * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} to associate with the * slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#stops Read more...} */ stops?: HeatmapColorStop[]; /** * The view model for the Heatmap widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html#viewModel Read more...} */ viewModel?: HeatmapSliderViewModelProperties; } export class HeatmapSliderViewModel extends SmartMappingSliderViewModel { /** * The colorStops * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} to associate with the * slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#stops Read more...} */ stops: HeatmapColorStop[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider.html HeatmapSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html Read more...} */ constructor(properties?: HeatmapSliderViewModelProperties); /** * Generates the color ramp gradient rendered on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#getStopInfo Read more...} */ getStopInfo(): HeatmapSliderViewModelStopInfo[]; } interface HeatmapSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * The colorStops * of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-HeatmapRenderer.html HeatmapRenderer} to associate with the * slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#stops Read more...} */ stops?: HeatmapColorStop[]; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#getColorStopInfo getColorStopInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-HeatmapSlider-HeatmapSliderViewModel.html#StopInfo Read more...} */ export interface HeatmapSliderViewModelStopInfo { color: Color; 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 widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#label Read more...} */ label: string; /** * The opacity stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html OpacityVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#stops Read more...} */ stops: OpacityStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#style Read more...} */ style: OpacitySliderStyle; /** * The OpacitySlider widget is intended for authoring and exploring data-driven visualizations in any * layer that can be rendered with an {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html OpacityVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html Read more...} */ constructor(properties?: OpacitySliderProperties); /** * The view model for the OpacitySlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#viewModel Read more...} */ get viewModel(): OpacitySliderViewModel; set viewModel(value: OpacitySliderViewModelProperties); /** * A convenience function used to update the properties of an OpacitySlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#VisualVariableResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable createVisualVariable} * method. * * @param visualVariableResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable createVisualVariable} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#updateFromVisualVariableResult Read more...} */ updateFromVisualVariableResult(visualVariableResult: opacityVisualVariableResult, histogramResult?: HistogramResult): void; /** * A convenience function used to create an OpacitySlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#VisualVariableResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable createVisualVariable} * method. * * @param visualVariableResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-opacity.html#createVisualVariable createVisualVariable} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#fromVisualVariableResult Read more...} */ static fromVisualVariableResult(visualVariableResult: opacityVisualVariableResult, histogramResult?: HistogramResult): OpacitySlider; } interface OpacitySliderProperties extends SmartMappingSliderBaseProperties { /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#label Read more...} */ label?: string; /** * The opacity stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html OpacityVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#stops Read more...} */ stops?: OpacityStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#style Read more...} */ style?: OpacitySliderStyle; /** * The view model for the OpacitySlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html#viewModel Read more...} */ viewModel?: OpacitySliderViewModelProperties; } export class OpacitySliderViewModel extends SmartMappingSliderViewModel { /** * The opacity stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html OpacityVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#stops Read more...} */ stops: OpacityStop[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider.html OpacitySlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html Read more...} */ constructor(properties?: OpacitySliderViewModelProperties); /** * Generates the opacity ramp gradient rendered on the slider. * * @param stopColor The stop color. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#getStopInfo Read more...} */ getStopInfo(stopColor?: Color | nullish): OpacitySliderViewModelStopInfo[]; } interface OpacitySliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * The opacity stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-OpacityVariable.html OpacityVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#stops Read more...} */ stops?: OpacityStop[]; } /** * The return object of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#getStopInfo getStopInfo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-OpacitySlider-OpacitySliderViewModel.html#StopInfo Read more...} */ export interface OpacitySliderViewModelStopInfo { color: Color; offset: number; } export interface OpacitySliderStyle { trackFillColor?: Color; } export class SizeSlider extends SmartMappingSliderBase { /** * Only applicable when three thumbs (i.e. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#label Read more...} */ label: string; /** * Only applicable when three thumbs (i.e. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#stops Read more...} */ stops: SizeStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#style Read more...} */ style: SizeSliderStyle; /** * The SizeSlider widget is intended for authoring and exploring data-driven visualizations in any * layer that can be rendered with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html Read more...} */ constructor(properties?: SizeSliderProperties); /** * The view model for the SizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#viewModel Read more...} */ get viewModel(): SizeSliderViewModel; set viewModel(value: SizeSliderViewModelProperties); /** * A convenience function used to update the properties of a SizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#updateFromRendererResult Read more...} */ updateFromRendererResult(rendererResult: sizeContinuousRendererResult, histogramResult?: HistogramResult): void; /** * A convenience function used to update the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to match the values of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#stops stops} on the slider. * * @param sizeVariable The size visual variable from the renderer to update to the set {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#stops stops} on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#updateVisualVariable Read more...} */ updateVisualVariable(sizeVariable: SizeVariable): SizeVariable | nullish; /** * A convenience function used to create a SizeSlider widget instance from the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#ContinuousRendererResult result} of * the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer} * method. * * @param rendererResult The result object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-renderers-size.html#createContinuousRenderer createContinuousRenderer} method. * @param histogramResult The result histogram object from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-smartMapping-statistics-histogram.html#histogram histogram} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#fromRendererResult Read more...} */ static fromRendererResult(rendererResult: sizeContinuousRendererResult, histogramResult?: HistogramResult): SizeSlider; } interface SizeSliderProperties extends SmartMappingSliderBaseProperties { /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#label Read more...} */ label?: string; /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled?: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled?: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#stops Read more...} */ stops?: SizeStop[]; /** * Exposes various properties of the widget * that can be styled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#style Read more...} */ style?: SizeSliderStyle; /** * The view model for the SizeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html#viewModel Read more...} */ viewModel?: SizeSliderViewModelProperties; } export class SizeSliderViewModel extends SmartMappingPrimaryHandleSliderViewModel { /** * This property is typically used in diverging, or `above-and-below` renderer configurations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#stops Read more...} */ stops: SizeStop[]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider.html SizeSlider} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html Read more...} */ constructor(properties?: SizeSliderViewModelProperties); } interface SizeSliderViewModelProperties extends SmartMappingPrimaryHandleSliderViewModelProperties { /** * This property is typically used in diverging, or `above-and-below` renderer configurations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#persistSizeRangeEnabled Read more...} */ persistSizeRangeEnabled?: boolean; /** * The size stops from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-renderers-visualVariables-SizeVariable.html SizeVariable} * to link to the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SizeSlider-SizeSliderViewModel.html#stops Read more...} */ stops?: SizeStop[]; } export interface SizeSliderStyle { trackFillColor?: Color; trackBackgroundColor?: Color; } export class SmartMappingPrimaryHandleSliderViewModel extends SmartMappingSliderViewModel { /** * Only applicable when three thumbs (i.e. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled: boolean; /** * Shared properties for sliders that have a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled primaryHandle} option. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html Read more...} */ constructor(properties?: SmartMappingPrimaryHandleSliderViewModelProperties); } interface SmartMappingPrimaryHandleSliderViewModelProperties extends SmartMappingSliderViewModelProperties { /** * Only applicable when three thumbs (i.e. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#handlesSyncedToPrimary Read more...} */ handlesSyncedToPrimary?: boolean; /** * When `true`, the slider will render a third handle between the * two handles already provided by default. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingPrimaryHandleSliderViewModel.html#primaryHandleEnabled Read more...} */ primaryHandleEnabled?: boolean; } export class SmartMappingSliderBase extends Widget { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html Histogram} associated with the data represented on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#histogramConfig Read more...} */ histogramConfig: HistogramConfig | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction Read more...} */ inputFormatFunction: SmartMappingSliderBaseLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputParseFunction Read more...} */ inputParseFunction: InputParser | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelFormatFunction Slider.labelFormatFunction}, * which is a custom function used to format labels on the thumbs, min, max, and average * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#labelFormatFunction Read more...} */ labelFormatFunction: SmartMappingSliderBaseLabelFormatter | nullish; /** * The maximum value or upper bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#max Read more...} */ max: number; /** * The minimum value or lower bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#min Read more...} */ min: number; /** * Defines how slider thumb values should be rounded. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#precision Read more...} */ precision: number; /** * The state of the view model. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#syncedSegmentsEnabled Read more...} */ syncedSegmentsEnabled: boolean; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#visibleElements Read more...} */ visibleElements: SmartMappingSliderBaseVisibleElements; /** * Zooms the slider track to the bounds provided in this property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions Read more...} */ zoomOptions: SmartMappingSliderBaseZoomOptions | nullish; /** * The base class for all Smart Mapping slider widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html Histogram} associated with the data represented on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#histogramConfig Read more...} */ histogramConfig?: HistogramConfig | nullish; /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction Read more...} */ inputFormatFunction?: SmartMappingSliderBaseLabelFormatter | nullish; /** * Function used to parse slider inputs formatted by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction inputFormatFunction}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#inputParseFunction Read more...} */ inputParseFunction?: InputParser | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider.html#labelFormatFunction Slider.labelFormatFunction}, * which is a custom function used to format labels on the thumbs, min, max, and average * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#labelFormatFunction Read more...} */ labelFormatFunction?: SmartMappingSliderBaseLabelFormatter | nullish; /** * The maximum value or upper bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#max Read more...} */ max?: number; /** * The minimum value or lower bound of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#min Read more...} */ min?: number; /** * Defines how slider thumb values should be rounded. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#precision Read more...} */ precision?: number; /** * When `true`, all segments will sync together in updating thumb values when the user drags any segment. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#syncedSegmentsEnabled Read more...} */ syncedSegmentsEnabled?: boolean; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#visibleElements Read more...} */ visibleElements?: SmartMappingSliderBaseVisibleElements; /** * Zooms the slider track to the bounds provided in this property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#zoomOptions Read more...} */ zoomOptions?: SmartMappingSliderBaseZoomOptions | nullish; } /** * Configuration options for defining the slider's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Histogram.html Histogram}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderBase.html#HistogramConfig Read more...} */ export interface HistogramConfig { average?: number; barCreatedFunction?: BarCreatedFunction; bins?: HistogramBin[]; dataLines?: HistogramConfigDataLines[]; dataLineCreatedFunction?: DataLineCreatedFunction; standardDeviation?: number; standardDeviationCount?: number; } export type SmartMappingSliderBaseLabelFormatter = ( value: number, type?: "average" | "min" | "max" | "tick" | "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 { interactiveTrack?: boolean; } export interface SmartMappingSliderBaseZoomOptions { min?: number | nullish; max?: number | nullish; } 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 { value?: number; label?: string | number | nullish; } export class SmartMappingSliderViewModel extends SliderViewModel { /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#inputFormatFunction Read more...} */ inputFormatFunction: SmartMappingSliderBaseLabelFormatter | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction SliderViewModel.labelFormatFunction}, * which is a custom function used to format labels on the thumbs, min, max, and average * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction: SmartMappingSliderBaseLabelFormatter | nullish; /** * The data values associated with the thumb locations of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#values Read more...} */ readonly values: number[]; /** * Enables zooming on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomingEnabled Read more...} */ zoomingEnabled: boolean; /** * Zooms the slider track to the bounds provided in this property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions Read more...} */ zoomOptions: SmartMappingSliderViewModelZoomOptions | nullish; /** * Provides the shared base logic for the smart mapping slider view models. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html Read more...} */ constructor(properties?: SmartMappingSliderViewModelProperties); /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#max max} value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#getUnzoomedMax Read more...} */ getUnzoomedMax(): void; /** * Gets the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#min min} value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#getUnzoomedMin Read more...} */ getUnzoomedMin(): void; } interface SmartMappingSliderViewModelProperties extends SliderViewModelProperties { /** * A function used to format user inputs. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#inputFormatFunction Read more...} */ inputFormatFunction?: SmartMappingSliderBaseLabelFormatter | nullish; /** * A modified version of * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Slider-SliderViewModel.html#labelFormatFunction SliderViewModel.labelFormatFunction}, * which is a custom function used to format labels on the thumbs, min, max, and average * values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#labelFormatFunction Read more...} */ labelFormatFunction?: SmartMappingSliderBaseLabelFormatter | nullish; /** * Enables zooming on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomingEnabled Read more...} */ zoomingEnabled?: boolean; /** * Zooms the slider track to the bounds provided in this property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-SmartMappingSliderViewModel.html#zoomOptions Read more...} */ zoomOptions?: SmartMappingSliderViewModelZoomOptions | nullish; } export interface SmartMappingSliderViewModelZoomOptions { min?: number | nullish; max?: number | nullish; } /** * Various utils for tying Smart Mapping renderers to the Smart Mapping * slider widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-support-utils.html Read more...} */ interface smartMappingSupportUtils { /** * Formats a UNIX timestamp to a basic date string. * * @param value The UNIX timestamp to convert to a formatted date string. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-support-utils.html#formatDateLabel Read more...} */ formatDateLabel(value: number): string; /** * Formats a numeric value for display as a label based on the current locale. * * @param value The value to convert to a formatted label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-support-utils.html#formatNumberLabel Read more...} */ formatNumberLabel(value: number): string; /** * Computes and returns standard deviation values based on the given average and standard deviation. * * @param standardDeviation The standard deviation from the given `average`. * @param average The average of the dataset from which to compute standard deviation values. * @param count The number of standard deviations from the mean to compute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-smartMapping-support-utils.html#getDeviationValues Read more...} */ getDeviationValues(standardDeviation: number | nullish, average: number | nullish, count: number): number[]; } export const smartMappingSupportUtils: smartMappingSupportUtils; export class GeolocationPositioning { geolocationOptions: any | nullish; goToLocationEnabled: boolean; scale: number | nullish; view: MapView | SceneView | nullish; get graphic(): Graphic; set graphic(value: GraphicProperties); } interface GeolocationPositioningProperties { geolocationOptions?: any | nullish; goToLocationEnabled?: boolean; graphic?: GraphicProperties; scale?: number | nullish; view?: MapView | SceneView | nullish; } export class GoTo { goToOverride: GoToOverride | nullish; } interface GoToProperties { goToOverride?: GoToOverride | nullish; } export class GridControls extends Widget { /** * Icon which represents the widget. * * @default "grid-unit" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#label Read more...} */ label: string; /** * The color scheme used to display the grid. * * @default "light" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#theme Read more...} */ theme: "light" | "dark" | "custom" | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#view Read more...} */ view: MapView | nullish; /** * The `GridControls` can be configured using the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#visibleElements visibleElements} below. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html Read more...} */ constructor(properties?: GridControlsProperties); /** * The custom color used for drawing the grid, if any. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#customColor Read more...} */ get customColor(): Color | nullish; set customColor(value: ColorProperties | nullish); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} that will be controlled by this * widget if the snapping toggle is enabled for display by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#visibleElements visibleElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions | nullish; set snappingOptions(value: SnappingOptionsProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#viewModel Read more...} */ get viewModel(): GridControlsViewModel; set viewModel(value: GridControlsViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#visibleElements Read more...} */ get visibleElements(): GridControlsVisibleElements; set visibleElements(value: GridControlsVisibleElementsProperties); } interface GridControlsProperties extends WidgetProperties { /** * The custom color used for drawing the grid, if any. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#customColor Read more...} */ customColor?: ColorProperties | nullish; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#label Read more...} */ label?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} that will be controlled by this * widget if the snapping toggle is enabled for display by {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#visibleElements visibleElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties | nullish; /** * The color scheme used to display the grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#theme Read more...} */ theme?: "light" | "dark" | "custom" | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#viewModel Read more...} */ viewModel?: GridControlsViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#visibleElements Read more...} */ visibleElements?: GridControlsVisibleElementsProperties; } export class GridControlsViewModel extends Accessor { /** * Returns `true` if the grid is enabled for display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#displayEnabled Read more...} */ readonly displayEnabled: boolean; /** * Returns `true` if the grid is set to scale dynamically. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling Read more...} */ dynamicScaling: boolean; /** * Returns the effective spacing of grid lines after applying the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling dynamicScaling} * setting at the current view scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#effectiveSpacingAfterDynamicScaling Read more...} */ readonly effectiveSpacingAfterDynamicScaling: number | nullish; /** * Returns `true` if the grid is in a valid state for manually setting grid properties or starting an interactive placement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#gridControlsEnabled Read more...} */ readonly gridControlsEnabled: boolean; /** * True if the grid is currently not displayed (and therefore also not a valid snap target), * because {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling dynamicScaling} is off and the grid cells are too small * to render at the current scale. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#gridOutOfScale Read more...} */ readonly gridOutOfScale: boolean; /** * Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#interactivePlacementState Read more...} */ interactivePlacementState: "interactive" | "place" | "rotate" | nullish; /** * Controls the number of grid lines shown at 50% opacity between opaque grid lines when using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling dynamicScaling}. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#majorLineInterval Read more...} */ majorLineInterval: number; /** * True if the spacing input should be shown for the current view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#numericSpacingInputShouldBeVisible Read more...} */ readonly numericSpacingInputShouldBeVisible: boolean; /** * If true, interactive placement tools should be disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#placementDisabled Read more...} */ placementDisabled: boolean; /** * Determines the behavior of the grid when the map's viewpoint is rotated. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#rotateWithMap Read more...} */ rotateWithMap: boolean; /** * The grid's rotation in radians. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#rotation Read more...} */ rotation: number; /** * Controls snapping behavior if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingOptions snappingOptions} has been defined. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingEnabled Read more...} */ snappingEnabled: boolean; /** * Length of a grid cell. * * @default 1 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#spacing Read more...} */ spacing: number; /** * Unit of measure (foot, meter, etc) used when defining the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#spacing spacing} grid cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#unit Read more...} */ unit: LengthUnit | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html GridControls}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html Read more...} */ constructor(properties?: GridControlsViewModelProperties); /** * Sets the color used for grid display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#gridColor Read more...} */ get gridColor(): Color | nullish; set gridColor(value: ColorProperties | nullish); /** * This is the snapping options object that will be configured by the 'enable snapping' property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions | nullish; set snappingOptions(value: SnappingOptionsProperties | nullish); /** * Try to enable or disable grid display. * * @param visible Controls whether to try to enable or disable grid display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#trySetDisplayEnabled Read more...} */ trySetDisplayEnabled(visible: boolean): void; } interface GridControlsViewModelProperties { /** * Returns `true` if the grid is set to scale dynamically. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling Read more...} */ dynamicScaling?: boolean; /** * Sets the color used for grid display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#gridColor Read more...} */ gridColor?: ColorProperties | nullish; /** * Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#interactivePlacementState Read more...} */ interactivePlacementState?: "interactive" | "place" | "rotate" | nullish; /** * Controls the number of grid lines shown at 50% opacity between opaque grid lines when using {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#dynamicScaling dynamicScaling}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#majorLineInterval Read more...} */ majorLineInterval?: number; /** * If true, interactive placement tools should be disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#placementDisabled Read more...} */ placementDisabled?: boolean; /** * Determines the behavior of the grid when the map's viewpoint is rotated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#rotateWithMap Read more...} */ rotateWithMap?: boolean; /** * The grid's rotation in radians. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#rotation Read more...} */ rotation?: number; /** * Controls snapping behavior if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingOptions snappingOptions} has been defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingEnabled Read more...} */ snappingEnabled?: boolean; /** * This is the snapping options object that will be configured by the 'enable snapping' property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties | nullish; /** * Length of a grid cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#spacing Read more...} */ spacing?: number; /** * Unit of measure (foot, meter, etc) used when defining the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#spacing spacing} grid cell. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#unit Read more...} */ unit?: LengthUnit | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls-GridControlsViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#VisibleElements Read more...} */ export interface GridControlsVisibleElementsProperties { colorSelection?: boolean; dynamicScaleToggle?: boolean; gridEnabledToggle?: boolean; numericInputs?: boolean; gridSnapEnabledToggle?: boolean; lineIntervalInput?: boolean; outOfScaleWarning?: boolean; placementButtons?: boolean; rotateWithMapToggle?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-GridControls.html#VisibleElements Read more...} */ export interface GridControlsVisibleElements extends AnonymousAccessor { colorSelection: boolean; dynamicScaleToggle: boolean; gridEnabledToggle: boolean; numericInputs: boolean; gridSnapEnabledToggle: boolean; lineIntervalInput: boolean; outOfScaleWarning: boolean; placementButtons: boolean; rotateWithMapToggle: boolean; } export class SnappingControls extends Widget { /** * Icon which represents the widget. * * @default "snap-to-point" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#icon Read more...} */ icon: string; /** * The SnappingControls widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#label Read more...} */ label: string; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The SnappingControls widget provides a user interface to use alongside the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} class. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html Read more...} */ constructor(properties?: SnappingControlsProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); /** * The view model for the SnappingControls widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#viewModel Read more...} */ get viewModel(): SnappingControlsViewModel; set viewModel(value: SnappingControlsViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#visibleElements Read more...} */ get visibleElements(): SnappingControlsVisibleElements; set visibleElements(value: SnappingControlsVisibleElementsProperties); } interface SnappingControlsProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#icon Read more...} */ icon?: string; /** * The SnappingControls widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#label Read more...} */ label?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for the SnappingControls widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#viewModel Read more...} */ viewModel?: SnappingControlsViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#visibleElements Read more...} */ visibleElements?: SnappingControlsVisibleElementsProperties; } export class SnappingControlsViewModel extends Accessor { /** * The current state of the view model. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html#state Read more...} */ readonly state: "ready" | "disabled"; /** * The view associated with the SnappingControls widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html SnappingControls} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html Read more...} */ constructor(properties?: SnappingControlsViewModelProperties); /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html#snappingOptions Read more...} */ get snappingOptions(): SnappingOptions; set snappingOptions(value: SnappingOptionsProperties); } interface SnappingControlsViewModelProperties { /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-interactive-snapping-SnappingOptions.html SnappingOptions} for sketching. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html#snappingOptions Read more...} */ snappingOptions?: SnappingOptionsProperties; /** * The view associated with the SnappingControls widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls-SnappingControlsViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#VisibleElements Read more...} */ export interface SnappingControlsVisibleElementsProperties { enabledToggle?: boolean; featureEnabledToggle?: boolean; gridControls?: boolean; gridControlsElements?: GridControlsVisibleElementsProperties; gridEnabledToggle?: boolean; header?: boolean; layerList?: boolean; layerListToggleLayersButton?: boolean; selfEnabledToggle?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-SnappingControls.html#VisibleElements Read more...} */ export interface SnappingControlsVisibleElements extends AnonymousAccessor { get gridControlsElements(): GridControlsVisibleElements; set gridControlsElements(value: GridControlsVisibleElementsProperties); enabledToggle: boolean; featureEnabledToggle: boolean; gridControls: boolean; gridEnabledToggle: boolean; header: boolean; layerList: boolean; layerListToggleLayersButton: boolean; selfEnabledToggle: boolean; } namespace widget { /** * This convenience decorator is used to help simplify accessibility within the widget keyboard events. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#accessibleHandler Read more...} */ function accessibleHandler(): Function; /** * Utility method used for creating CSS animation/transition functions. * * @param type The animation/transition type. * @param className The animation/transition class name. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#cssTransition Read more...} */ function cssTransition(type: "enter" | "exit", className: string): Function; /** * Utility method used to determine if a pressed key should activate button behavior. * * @param key The [KeyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#isActivationKey Read more...} */ function isActivationKey(key: string): boolean; /** * Utility method used to determine if the directionality * of the text of the document is right-to-left. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#isRTL Read more...} */ function isRTL(): boolean; /** * This convenience decorator is used to help simplify localization of the widget. * * @param bundleId The bundle identifier passed to {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-intl.html#fetchMessageBundle intl.fetchMessageBundle()}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#messageBundle Read more...} */ function messageBundle(bundleId?: string): Function; /** * This convenience method is used to assign an {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement} DOM node reference to a variable. * * @param node The referenced DOM node. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#storeNode Read more...} */ function storeNode(node: HTMLElement): void; /** * This convenience decorator helps dispatch view model events on the widget instance. * * @param eventNames The event names to re-dispatch. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#vmEvent Read more...} */ function vmEvent(eventNames: string | string[]): Function; /** * This convenience method is used to render the JSX in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#render widget.render()} method. * * @param selector The element to create. * @param properties The element's properties. * @param children The element's children. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#tsx Read more...} */ function tsx(selector: string | Function, properties: any | nullish, ...children: any[][]): any; namespace tsx { namespace JSX { interface IntrinsicElements { [elementName: string]: any; } interface Element { } } } } export type GoToOverride = (view: MapView | SceneView, goToParameters: GoToParameters) => void; /** * The parameters for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView's goTo()} method and the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView's goTo()} method. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-support-widget.html#GoToParameters Read more...} */ export interface GoToParameters { target: GoToTarget2D & GoToTarget3D; options?: GoToOptions2D & GoToOptions3D; } export class Swipe extends Widget { /** * The direction the Swipe widget moves across the view. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#direction Read more...} */ direction: "horizontal" | "vertical"; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#disabled Read more...} */ disabled: boolean; /** * The text that shows in a tooltip when hovering over the handle of * the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#dragLabel Read more...} */ dragLabel: string; /** * Icon which represents the widget. * * @default "compare" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#label Read more...} */ label: string; /** * The position of the Swipe widget. * * @default 25 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#position Read more...} */ position: number; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#view Read more...} */ view: MapView | nullish; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#visibleElements Read more...} */ visibleElements: SwipeVisibleElements; /** * The Swipe widget provides a tool to show a portion of a layer or layers * on top of a map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html Read more...} */ constructor(properties?: SwipeProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the left or top side of the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#leadingLayers Read more...} */ get leadingLayers(): Collection; set leadingLayers(value: CollectionProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the right or bottom side of the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#trailingLayers Read more...} */ get trailingLayers(): Collection; set trailingLayers(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#viewModel Read more...} */ get viewModel(): SwipeViewModel; set viewModel(value: SwipeViewModelProperties); } interface SwipeProperties extends WidgetProperties { /** * The direction the Swipe widget moves across the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#direction Read more...} */ direction?: "horizontal" | "vertical"; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#disabled Read more...} */ disabled?: boolean; /** * The text that shows in a tooltip when hovering over the handle of * the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#dragLabel Read more...} */ dragLabel?: string; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#label Read more...} */ label?: string; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the left or top side of the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#leadingLayers Read more...} */ leadingLayers?: CollectionProperties; /** * The position of the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#position Read more...} */ position?: number; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the right or bottom side of the Swipe widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#trailingLayers Read more...} */ trailingLayers?: CollectionProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#viewModel Read more...} */ viewModel?: SwipeViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#visibleElements Read more...} */ visibleElements?: SwipeVisibleElements; } export class SwipeViewModel extends Accessor { /** * The direction the Swipe moves across the view. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#direction Read more...} */ direction: "horizontal" | "vertical"; /** * The maximum position of the Swipe, as a percentage. * * @default 100 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#max Read more...} */ readonly max: number; /** * The minimum position of the Swipe, as a percentage. * * @default 0 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#min Read more...} */ readonly min: number; /** * The position of the Swipe. * * @default 25 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#position Read more...} */ position: number; /** * The current state of the Swipe. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * The step value used to increment or decrement the position of the Swipe when using keyboard navigation. * * @default 0.5 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#step Read more...} */ step: number; /** * The multiplier used to increase the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#step step} value when the `Shift` key is pressed in combination with one of the arrow keys. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#stepMultiplier Read more...} */ stepMultiplier: number; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html Swipe widget} and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-swipe/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html Read more...} */ constructor(properties?: SwipeViewModelProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the left or top side of the Swipe. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#leadingLayers Read more...} */ get leadingLayers(): Collection; set leadingLayers(value: CollectionProperties); /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the right or bottom side of the Swipe. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#trailingLayers Read more...} */ get trailingLayers(): Collection; set trailingLayers(value: CollectionProperties); } interface SwipeViewModelProperties { /** * The direction the Swipe moves across the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#direction Read more...} */ direction?: "horizontal" | "vertical"; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the left or top side of the Swipe. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#leadingLayers Read more...} */ leadingLayers?: CollectionProperties; /** * The position of the Swipe. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#position Read more...} */ position?: number; /** * The step value used to increment or decrement the position of the Swipe when using keyboard navigation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#step Read more...} */ step?: number; /** * The multiplier used to increase the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#step step} value when the `Shift` key is pressed in combination with one of the arrow keys. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#stepMultiplier Read more...} */ stepMultiplier?: number; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}s that will show on the right or bottom side of the Swipe. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#trailingLayers Read more...} */ trailingLayers?: CollectionProperties; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe-SwipeViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Swipe.html#VisibleElements Read more...} */ export interface SwipeVisibleElements { handle?: boolean; divider?: boolean; } export class TableList extends Widget { /** * Indicates whether the widget is collapsed. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#collapsed Read more...} */ collapsed: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#dragEnabled Read more...} */ dragEnabled: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterPlaceholder Read more...} */ filterPlaceholder: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html list items}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterPredicate Read more...} */ filterPredicate: TableListFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements visibleElements.filter} is true. * * @default "" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterText Read more...} */ filterText: string; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#title title} of the widget. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "table" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#label Read more...} */ label: string; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: TableListListItemCreatedHandler | nullish; /** * A reference to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} containing the tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#map Read more...} */ map: Map | WebMap | nullish; /** * The minimum number of list items required to enable drag and drop reordering with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#dragEnabled dragEnabled}. * * @default 2 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#minDragEnabledItems Read more...} */ minDragEnabledItems: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#minFilterItems Read more...} */ minFilterItems: number; /** * Specifies the selection mode. * * @default "none" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#selectionMode Read more...} */ selectionMode: "multiple" | "none" | "single" | "single-persist"; /** * The collection of table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}s displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#tableItems Read more...} */ readonly tableItems: Collection; /** * The TableList widget provides a way to display a list of tables associated with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html Map}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html Read more...} */ constructor(properties?: TableListProperties); /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}s representing table list items * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#selectedItems Read more...} */ get selectedItems(): Collection; set selectedItems(value: CollectionProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#viewModel Read more...} */ get viewModel(): TableListViewModel; set viewModel(value: TableListViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements Read more...} */ get visibleElements(): TableListVisibleElements; set visibleElements(value: TableListVisibleElementsProperties); /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#triggerAction Read more...} */ triggerAction(action: ActionButton | ActionToggle, item: TableListListItem): void; on(name: "trigger-action", eventHandler: TableListTriggerActionEventHandler): IHandle; } interface TableListProperties extends WidgetProperties { /** * Indicates whether the widget is collapsed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#collapsed Read more...} */ collapsed?: boolean; /** * Indicates whether {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html list items} may be reordered within the list by dragging and dropping. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#dragEnabled Read more...} */ dragEnabled?: boolean; /** * Placeholder text used in the filter input if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterPlaceholder Read more...} */ filterPlaceholder?: string; /** * Specifies a function to handle filtering {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html list items}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterPredicate Read more...} */ filterPredicate?: TableListFilterPredicate | nullish; /** * The value of the filter input text string if {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements visibleElements.filter} is true. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#filterText Read more...} */ filterText?: string; /** * Indicates the heading level to use for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#title title} of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#label Read more...} */ label?: string; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: TableListListItemCreatedHandler | nullish; /** * A reference to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} containing the tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#map Read more...} */ map?: Map | WebMap | nullish; /** * The minimum number of list items required to enable drag and drop reordering with {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#dragEnabled dragEnabled}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#minDragEnabledItems Read more...} */ minDragEnabledItems?: number; /** * The minimum number of list items required to display the visibleElements.filter input box. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#minFilterItems Read more...} */ minFilterItems?: number; /** * A collection of selected {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}s representing table list items * selected by the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#selectedItems Read more...} */ selectedItems?: CollectionProperties; /** * Specifies the selection mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#selectionMode Read more...} */ selectionMode?: "multiple" | "none" | "single" | "single-persist"; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#viewModel Read more...} */ viewModel?: TableListViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#visibleElements Read more...} */ visibleElements?: TableListVisibleElementsProperties; } export class TableListListItem extends Identifiable { /** * Indicates whether the actions panel is open in the TableList. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#actionsOpen Read more...} */ actionsOpen: boolean; /** * The Error object returned if an error occurred. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#error Read more...} */ readonly error: Error | nullish; /** * When `true`, hides the layer from the TableList instance. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#hidden Read more...} */ hidden: boolean; /** * The layer associated with the triggered action. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#layer Read more...} */ layer: Layer | Sublayer | SubtypeSublayer | SubtypeGroupLayer; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the child layers in the list item. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * Whether the layer is open in the TableList. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#open Read more...} */ open: boolean; /** * The parent of this item. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#parent Read more...} */ parent: TableListListItem | nullish; /** * Value is `true` when the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#layer layer} is being published. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#publishing Read more...} */ readonly publishing: boolean; /** * The title of the table. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#title Read more...} */ title: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; constructor(); /** * A nested 2-dimensional collection of actions that could be triggered on the item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#actionsSections Read more...} */ get actionsSections(): Collection>; set actionsSections(value: | 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#children Read more...} */ get children(): Collection; set children(value: CollectionProperties); /** * Allows you to display custom content for each ListItem * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#panel Read more...} */ get panel(): TableListListItemPanel; set panel(value: TableListListItemPanelProperties); /** * Creates a deep clone of this object. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html#clone Read more...} */ clone(): TableListListItem; } export interface TableListListItemPanel extends Widget, Identifiable { } export class TableListListItemPanel { /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#content Read more...} */ content: TableListItemPanelContent | TableListItemPanelContent[] | nullish; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#disabled Read more...} */ disabled: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://doc.geoscene.cn/calcite-design-system/components/flow-item/). * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#flowEnabled Read more...} */ flowEnabled: boolean; /** * The URL or data URI of an image used to represent the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#image Read more...} */ image: string | nullish; /** * The panel's parent ListItem that represents a table in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#listItem Read more...} */ listItem: TableListListItem | nullish; /** * Indicates if the panel's content is open and visible to the user. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#open Read more...} */ open: boolean; /** * The title of the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#title Read more...} */ title: string; /** * An automatically generated unique identifier assigned to the instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#uid Read more...} */ declare readonly uid: Identifiable["uid"]; /** * This class allows you to display custom content for each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem} * in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html Read more...} */ constructor(properties?: TableListListItemPanelProperties); } interface TableListListItemPanelProperties extends WidgetProperties, IdentifiableProperties { /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#content Read more...} */ content?: TableListItemPanelContent | TableListItemPanelContent[] | nullish; /** * If `true`, disables the ListItem's panel so the user cannot open or interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#disabled Read more...} */ disabled?: boolean; /** * Indicates whether the panel's content should be rendered as a [Calcite Flow Item](https://doc.geoscene.cn/calcite-design-system/components/flow-item/). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#flowEnabled Read more...} */ flowEnabled?: boolean; /** * The URL or data URI of an image used to represent the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#image Read more...} */ image?: string | nullish; /** * The panel's parent ListItem that represents a table in the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#listItem Read more...} */ listItem?: TableListListItem | nullish; /** * Indicates if the panel's content is open and visible to the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#open Read more...} */ open?: boolean; /** * The title of the panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#title Read more...} */ title?: string; } /** * The content displayed in the ListItem panel. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItemPanel.html#TableListItemPanelContent Read more...} */ export type TableListItemPanelContent = string | Widget | HTMLElement; export interface TableListViewModel extends Accessor, Evented { } export class TableListViewModel { /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList}. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled: boolean; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction: TableListViewModelListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all tables. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#listModeDisabled Read more...} */ listModeDisabled: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} containing the tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#map Read more...} */ map: Map | WebMap | nullish; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#state Read more...} */ readonly state: "loading" | "ready" | "disabled"; /** * The collection of table {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}s displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#tableItems Read more...} */ readonly tableItems: Collection; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#tables Read more...} */ tables: Collection | nullish; /** * The total number of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#tableItems tableItems} in the list. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#totalItems Read more...} */ readonly totalItems: number; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-table-list/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html Read more...} */ constructor(properties?: TableListViewModelProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * Triggers the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#event-trigger-action trigger-action} event and executes * the given {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionButton.html action} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-support-actions-ActionToggle.html action toggle}. * * @param action The action to execute. * @param item An item associated with the action. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#triggerAction Read more...} */ triggerAction(action: ActionButton | ActionToggle, item: TableListListItem): void; on(name: "trigger-action", eventHandler: TableListViewModelTriggerActionEventHandler): IHandle; } interface TableListViewModelProperties { /** * Whether to provide an indication if a layer is being published in the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html TableList}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#checkPublishStatusEnabled Read more...} */ checkPublishStatusEnabled?: boolean; /** * Specifies a function that accesses each {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-ListItem.html ListItem}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#listItemCreatedFunction Read more...} */ listItemCreatedFunction?: TableListViewModelListItemCreatedHandler | nullish; /** * Specifies whether to ignore the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html#listMode listMode} property of the layers to display all tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#listModeDisabled Read more...} */ listModeDisabled?: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-Map.html map} containing the tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#map Read more...} */ map?: Map | WebMap | nullish; /** * A collection of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html layer} instances that are tables. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList-TableListViewModel.html#tables Read more...} */ tables?: Collection | nullish; } export type TableListViewModelListItemCreatedHandler = (event: TableListViewModelListItemCreatedHandlerEvent) => void; export interface TableListViewModelTriggerActionEvent { action: ActionButton | ActionToggle; item: TableListListItem; } export interface TableListViewModelListItemCreatedHandlerEvent { item: TableListListItem; } export type TableListFilterPredicate = (item: TableListListItem) => void; export type TableListListItemCreatedHandler = (event: TableListListItemCreatedHandlerEvent) => void; export interface TableListTriggerActionEvent { action: ActionButton | ActionToggle; item: TableListListItem; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#VisibleElements Read more...} */ export interface TableListVisibleElementsProperties { closeButton?: boolean; collapseButton?: boolean; errors?: boolean; filter?: boolean; flow?: boolean; heading?: boolean; statusIndicators?: boolean; temporaryTableIndicators?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TableList.html#VisibleElements Read more...} */ export interface TableListVisibleElements extends AnonymousAccessor { closeButton: boolean; collapseButton: boolean; errors: boolean; filter: boolean; flow: boolean; heading: boolean; statusIndicators: boolean; temporaryTableIndicators: boolean; } export interface TableListListItemCreatedHandlerEvent { item: TableListListItem; } export class widgetsTimeSlider extends Widget { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#disabled Read more...} */ disabled: boolean; /** * Lists the specific locations on the timeline where handle(s) will snap to when manipulated. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#effectiveStops Read more...} */ readonly effectiveStops: Date[] | nullish; /** * Icon which represents the widget. * * @default "clock" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#label Read more...} */ label: string; /** * A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#labelFormatFunction Read more...} */ labelFormatFunction: DateLabelFormatter | nullish; /** * Determines the layout used by the TimeSlider widget. * * @default "auto" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#layout Read more...} */ layout: "auto" | "compact" | "wide"; /** * When `true`, the time slider will play its animation in a loop. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#loop Read more...} */ loop: boolean; /** * The time slider mode. * * @default "time-window" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#mode Read more...} */ mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#playRate Read more...} */ playRate: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#stops Read more...} */ stops: StopsByDates | StopsByCount | StopsByInterval | nullish; /** * When set, overrides the default TimeSlider ticks labelling system. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#tickConfigs Read more...} */ tickConfigs: TickConfig[] | nullish; /** * Shows/hides time in the display. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeVisible Read more...} */ timeVisible: boolean; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeZone Read more...} */ timeZone: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The TimeSlider widget simplifies visualization of temporal data * in your application. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html Read more...} */ constructor(properties?: widgetsTimeSliderProperties); /** * Defines actions that will appear in a menu when the user clicks the ellipsis button * !{@link https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/timeslider/ellipsis.png timeSlider-actions-menu} in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#actions Read more...} */ get actions(): Collection; set actions(value: CollectionProperties); /** * The temporal extent of the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#fullTimeExtent Read more...} */ get fullTimeExtent(): TimeExtent | nullish; set fullTimeExtent(value: TimeExtentProperties | nullish); /** * The current time extent of the time slider. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#viewModel Read more...} */ get viewModel(): TimeSliderViewModel; set viewModel(value: TimeSliderViewModelProperties); /** * Incrementally moves the time extent forward one stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#next Read more...} */ next(): void; /** * Initiates the time slider's temporal playback. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#play Read more...} */ play(): void; /** * Incrementally moves the time extent back one stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#previous Read more...} */ previous(): void; /** * Stops the time slider's temporal playback. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#stop Read more...} */ stop(): void; /** * Updates the time slider widget definition in the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @param document The webmap or webscene to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#updateWebDocument Read more...} */ updateWebDocument(document: WebMap | WebScene): void; on(name: "trigger-action", eventHandler: TimeSliderTriggerActionEventHandler): IHandle; } interface widgetsTimeSliderProperties extends WidgetProperties { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button * !{@link https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/timeslider/ellipsis.png timeSlider-actions-menu} in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#actions Read more...} */ actions?: CollectionProperties; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#disabled Read more...} */ disabled?: boolean; /** * The temporal extent of the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#fullTimeExtent Read more...} */ fullTimeExtent?: TimeExtentProperties | nullish; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#label Read more...} */ label?: string; /** * A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#labelFormatFunction Read more...} */ labelFormatFunction?: DateLabelFormatter | nullish; /** * Determines the layout used by the TimeSlider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#layout Read more...} */ layout?: "auto" | "compact" | "wide"; /** * When `true`, the time slider will play its animation in a loop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#loop Read more...} */ loop?: boolean; /** * The time slider mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#mode Read more...} */ mode?: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#playRate Read more...} */ playRate?: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#stops Read more...} */ stops?: StopsByDates | StopsByCount | StopsByInterval | nullish; /** * When set, overrides the default TimeSlider ticks labelling system. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#tickConfigs Read more...} */ tickConfigs?: TickConfig[] | nullish; /** * The current time extent of the time slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * Shows/hides time in the display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeVisible Read more...} */ timeVisible?: boolean; /** * Dates and times displayed in the widget will be displayed in this time zone. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#timeZone Read more...} */ timeZone?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#viewModel Read more...} */ viewModel?: TimeSliderViewModelProperties; } export class TimeSliderViewModel extends Accessor { /** * Defined specific locations on the timeline that the handles will snap to when manipulated. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#effectiveStops Read more...} */ readonly effectiveStops: Date[] | nullish; /** * If animating, the time indicator(s) will restart if they reach the edge. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#loop Read more...} */ loop: boolean; /** * The time slider mode. * * @default "time-window" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#mode Read more...} */ mode: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#playRate Read more...} */ playRate: number; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "playing"; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * @default { count : 10 } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#stops Read more...} */ stops: StopsByDates | StopsByCount | StopsByInterval | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html TimeSlider} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-time-slider/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html Read more...} */ constructor(properties?: TimeSliderViewModelProperties); /** * Defines actions that will appear in a menu when the user clicks the ellipsis button * !{@link https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/timeslider/ellipsis.png timeSlider-actions-menu} in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#actions Read more...} */ get actions(): Collection; set actions(value: CollectionProperties); /** * The temporal extent of the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent Read more...} */ get fullTimeExtent(): TimeExtent | nullish; set fullTimeExtent(value: TimeExtentProperties | nullish); /** * The current time extent of the time slider. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent Read more...} */ get timeExtent(): TimeExtent | nullish; set timeExtent(value: TimeExtentProperties | nullish); /** * Incrementally moves the time extent forward one stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#next Read more...} */ next(): void; /** * Initiates the time slider's temporal playback. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#play Read more...} */ play(): void; /** * Incrementally moves the time extent back one stop. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#previous Read more...} */ previous(): void; /** * Stops the time slider's temporal playback. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#stop Read more...} */ stop(): void; /** * Updates the time slider widget definition in the provided {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebScene.html WebScene}. * * @param document The webmap or webscene to be updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#updateWebDocument Read more...} */ updateWebDocument(document: WebMap | WebScene): void; on(name: "trigger-action", eventHandler: TimeSliderViewModelTriggerActionEventHandler): IHandle; } interface TimeSliderViewModelProperties { /** * Defines actions that will appear in a menu when the user clicks the ellipsis button * !{@link https://doc.geoscene.cn/javascript/4.33/assets/img/apiref/widgets/timeslider/ellipsis.png timeSlider-actions-menu} in the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#actions Read more...} */ actions?: CollectionProperties; /** * The temporal extent of the entire slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent Read more...} */ fullTimeExtent?: TimeExtentProperties | nullish; /** * If animating, the time indicator(s) will restart if they reach the edge. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#loop Read more...} */ loop?: boolean; /** * The time slider mode. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#mode Read more...} */ mode?: "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end"; /** * The time (in milliseconds) between animation steps. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#playRate Read more...} */ playRate?: number; /** * Defines specific locations on the time slider where thumbs will snap to when manipulated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#stops Read more...} */ stops?: StopsByDates | StopsByCount | StopsByInterval | nullish; /** * The current time extent of the time slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent Read more...} */ timeExtent?: TimeExtentProperties | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } /** * Definition of an action that can be assigned to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#actions actions} property on the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#actions TimeSlider} or the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#actions TimeSliderViewModel}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider-TimeSliderViewModel.html#action Read more...} */ export interface Action { icon: string; id: string; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#fullTimeExtent fullTimeExtent} into equal parts. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#StopsByCount Read more...} */ export interface StopsByCount { count: number; timeExtent?: TimeExtent; } /** * Specifies an array of dates for the time slider widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#StopsByDates Read more...} */ export interface StopsByDates { dates: Date[]; } /** * Defines regularly spaced stops on the time slider from a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-time-TimeInterval.html TimeInterval}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeSlider.html#StopsByInterval Read more...} */ export interface StopsByInterval { interval: TimeInterval; 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#disabled Read more...} */ disabled: boolean; /** * The direction the widget will expand. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#expandDirection Read more...} */ expandDirection: "start" | "end"; /** * The expanded state of the widget. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#expanded Read more...} */ expanded: boolean; /** * Icon which represents the widget. * * @default "time-zone" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#icon Read more...} */ icon: string; /** * A reference to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#view Read more...} */ view: MapView | nullish; /** * TimeZoneLabel is widget for displaying the current {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#timeZone time zone} of the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html Read more...} */ constructor(properties?: TimeZoneLabelProperties); } interface TimeZoneLabelProperties extends WidgetProperties { /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#disabled Read more...} */ disabled?: boolean; /** * The direction the widget will expand. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#expandDirection Read more...} */ expandDirection?: "start" | "end"; /** * The expanded state of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#expanded Read more...} */ expanded?: boolean; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#icon Read more...} */ icon?: string; /** * A reference to a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-TimeZoneLabel.html#view Read more...} */ view?: MapView | nullish; } export interface Track extends Widget, GoTo { } export class Track { /** * An object used for setting optional position parameters. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#geolocationOptions Read more...} */ geolocationOptions: any | nullish; /** * Indicates whether the widget will automatically navigate the view to the user's position * when a geolocation result is found. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#goToLocationEnabled Read more...} */ goToLocationEnabled: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * Icon displayed in the widget's button. * * @default "compass-north-circle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#label Read more...} */ label: 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#rotationEnabled Read more...} */ rotationEnabled: boolean; /** * Indicates the [scale](https://doc.geoscene.cn/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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#event-track track} event. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#scale Read more...} */ scale: number | nullish; /** * Indicates whether the widget is watching for new positions. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#tracking Read more...} */ readonly tracking: boolean; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides a simple button that animates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} * to the user's location when clicked. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html Read more...} */ constructor(properties?: TrackProperties); /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#graphic Read more...} */ get graphic(): Graphic; set graphic(value: GraphicProperties); /** * The viewModel for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#viewModel Read more...} */ get viewModel(): TrackViewModel; set viewModel(value: TrackViewModelProperties); /** * When executed, the widget will start {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#tracking tracking} the * user's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#start Read more...} */ start(): void; /** * Stops tracking the user's location when executed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#stop Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#geolocationOptions Read more...} */ geolocationOptions?: any | nullish; /** * Indicates whether the widget will automatically navigate the view to the user's position * when a geolocation result is found. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#goToLocationEnabled Read more...} */ goToLocationEnabled?: boolean; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#graphic Read more...} */ graphic?: GraphicProperties; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#label Read more...} */ label?: 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#rotationEnabled Read more...} */ rotationEnabled?: boolean; /** * Indicates the [scale](https://doc.geoscene.cn/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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#event-track track} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#scale Read more...} */ scale?: number | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The viewModel for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html#viewModel Read more...} */ viewModel?: TrackViewModelProperties; } export interface TrackViewModel extends Accessor, Evented, GeolocationPositioning, GoTo { } export class TrackViewModel { /** * Error that caused the last {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#event:track-error track-error} event to fire. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#error Read more...} */ error: any | Error | nullish; /** * An object used for setting optional position parameters. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#geolocationOptions Read more...} */ declare geolocationOptions: GeolocationPositioning["geolocationOptions"]; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#goToLocationEnabled Read more...} */ declare goToLocationEnabled: GeolocationPositioning["goToLocationEnabled"]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * A function that is used as an expression to evaluate geolocation points, and returns a boolean * value. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#positionFilterFunction Read more...} */ positionFilterFunction: Function | nullish; /** * Indicates whether the component 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#rotationEnabled Read more...} */ rotationEnabled: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated * result, after a location is returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#event-track track} event. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#scale Read more...} */ declare scale: GeolocationPositioning["scale"]; /** * The current state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "tracking" | "waiting" | "feature-unsupported" | "error"; /** * Indicates whether new positions are being watched. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#tracking Read more...} */ readonly tracking: boolean; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#view Read more...} */ declare view: GeolocationPositioning["view"]; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-track/ Track} component and {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track.html Track} widget, which * animates the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View} * to the user's location when clicked and tracks it as the location is updated. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html Read more...} */ constructor(properties?: TrackViewModelProperties); /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#graphic Read more...} */ get graphic(): Graphic; set graphic(value: GraphicProperties); /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * When executed, {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#tracking tracking} starts at the * user's location. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#start Read more...} */ start(): void; /** * Stops tracking the user's location when executed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#stop Read more...} */ 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#event:track-error track-error} event to fire. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#error Read more...} */ error?: any | Error | nullish; /** * An object used for setting optional position parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#geolocationOptions Read more...} */ geolocationOptions?: GeolocationPositioningProperties["geolocationOptions"]; /** * Indicates whether to navigate the view to the position and scale of the geolocated result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#goToLocationEnabled Read more...} */ goToLocationEnabled?: GeolocationPositioningProperties["goToLocationEnabled"]; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * The graphic used to show the user's location on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#graphic Read more...} */ graphic?: GraphicProperties; /** * A function that is used as an expression to evaluate geolocation points, and returns a boolean * value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#positionFilterFunction Read more...} */ positionFilterFunction?: Function | nullish; /** * Indicates whether the component 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#rotationEnabled Read more...} */ rotationEnabled?: boolean; /** * Indicates the scale to set on the view when navigating to the position of the geolocated * result, after a location is returned from the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#event-track track} event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#scale Read more...} */ scale?: GeolocationPositioningProperties["scale"]; /** * The view associated with the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Track-TrackViewModel.html#view Read more...} */ view?: GeolocationPositioningProperties["view"]; } 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 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations Read more...} */ autoRefreshAssociations: boolean; /** * Icon displayed in the widget's button. * * @default "view-associations" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#icon Read more...} */ icon: string; /** * Indicates whether to query and display connectivity associations. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations Read more...} */ includeConnectivityAssociations: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations Read more...} */ includeStructuralAttachmentAssociations: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#label Read more...} */ label: string; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations Read more...} */ maxAllowableAssociations: number; /** * The maximum value or upper bound of the Maximum allowable associations slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax Read more...} */ maxAllowableAssociationsSliderMax: number; /** * The minimum value or lower bound of the Maximum allowable associations slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin Read more...} */ maxAllowableAssociationsSliderMin: number; /** * Specifies the interval to move the maximum allowable associations slider with the up, or down keys. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep Read more...} */ maxAllowableAssociationsSliderStep: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showArrowsConnectivity Read more...} */ showArrowsConnectivity: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showArrowsStructuralAttachment Read more...} */ showArrowsStructuralAttachment: boolean; /** * When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations * every time the current map extent changes. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showAssociationsEnabled Read more...} */ showAssociationsEnabled: boolean; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view associated with the UtilityNetworkAssociations widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#view Read more...} */ view: MapView | nullish; /** * The UtilityNetworkAssociations widget class, functioning as a part of the GeoScene Maps SDK for JavaScript, * simplifies the management and manipulation of associations within a utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html Read more...} */ constructor(properties?: UtilityNetworkAssociationsProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being * drawn for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol Read more...} */ get connectivityAssociationsLineSymbol(): SimpleLineSymbol; set connectivityAssociationsLineSymbol(value: SimpleLineSymbolProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol Read more...} */ get structuralAttachmentAssociationsLineSymbol(): SimpleLineSymbol; set structuralAttachmentAssociationsLineSymbol(value: SimpleLineSymbolProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#viewModel Read more...} */ get viewModel(): UtilityNetworkAssociationsViewModel; set viewModel(value: UtilityNetworkAssociationsViewModelProperties); /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#visibleElements Read more...} */ get visibleElements(): UtilityNetworkAssociationsVisibleElements; set visibleElements(value: UtilityNetworkAssociationsVisibleElementsProperties); } 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations Read more...} */ autoRefreshAssociations?: boolean; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being * drawn for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol Read more...} */ connectivityAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#icon Read more...} */ icon?: string; /** * Indicates whether to query and display connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations Read more...} */ includeConnectivityAssociations?: boolean; /** * Indicates whether to query and display structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations Read more...} */ includeStructuralAttachmentAssociations?: boolean; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#label Read more...} */ label?: string; /** * The maximum number of associations that can be returned from the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations Read more...} */ maxAllowableAssociations?: number; /** * The maximum value or upper bound of the Maximum allowable associations slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax Read more...} */ maxAllowableAssociationsSliderMax?: number; /** * The minimum value or lower bound of the Maximum allowable associations slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin Read more...} */ maxAllowableAssociationsSliderMin?: number; /** * Specifies the interval to move the maximum allowable associations slider with the up, or down keys. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep Read more...} */ maxAllowableAssociationsSliderStep?: number; /** * Indicates whether to show arrows for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showArrowsConnectivity Read more...} */ showArrowsConnectivity?: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showArrowsStructuralAttachment Read more...} */ showArrowsStructuralAttachment?: boolean; /** * When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations * every time the current map extent changes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#showAssociationsEnabled Read more...} */ showAssociationsEnabled?: boolean; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol Read more...} */ structuralAttachmentAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view associated with the UtilityNetworkAssociations widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#viewModel Read more...} */ viewModel?: UtilityNetworkAssociationsViewModelProperties; /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#visibleElements Read more...} */ visibleElements?: UtilityNetworkAssociationsVisibleElementsProperties; } export class UtilityNetworkAssociationsViewModel extends Accessor { /** * Indicates whether to query and display connectivity associations. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeConnectivityAssociations Read more...} */ includeConnectivityAssociations: boolean; /** * Indicates whether to query and display structural attachment associations. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeStructuralAttachmentAssociations Read more...} */ includeStructuralAttachmentAssociations: boolean; /** * The maximum number of associations that can be returned from the server. * * @default 250 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#maxAllowableAssociations Read more...} */ maxAllowableAssociations: number; /** * Indicates whether to show arrows for connectivity associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsConnectivity Read more...} */ showArrowsConnectivity: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsStructuralAttachment Read more...} */ showArrowsStructuralAttachment: boolean; /** * The view model's state. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#state Read more...} */ readonly state: "disabled" | "loading" | "ready" | "executing" | "warning"; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view associated with the UtilityNetworkAssociations widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html UtilityNetworkAssociations} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-utility-network-associations/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html Read more...} */ constructor(properties?: UtilityNetworkAssociationsViewModelProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#connectivityAssociationsLineSymbol Read more...} */ get connectivityAssociationsLineSymbol(): SimpleLineSymbol; set connectivityAssociationsLineSymbol(value: SimpleLineSymbolProperties); /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#structuralAttachmentAssociationsLineSymbol Read more...} */ get structuralAttachmentAssociationsLineSymbol(): SimpleLineSymbol; set structuralAttachmentAssociationsLineSymbol(value: SimpleLineSymbolProperties); /** * Removes all associations from the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#removeAssociations Read more...} */ removeAssociations(): void; /** * Queries associations within the current map extent. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showAssociations Read more...} */ showAssociations(): Promise; } interface UtilityNetworkAssociationsViewModelProperties { /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#connectivityAssociationsLineSymbol Read more...} */ connectivityAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Indicates whether to query and display connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeConnectivityAssociations Read more...} */ includeConnectivityAssociations?: boolean; /** * Indicates whether to query and display structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#includeStructuralAttachmentAssociations Read more...} */ includeStructuralAttachmentAssociations?: boolean; /** * The maximum number of associations that can be returned from the server. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#maxAllowableAssociations Read more...} */ maxAllowableAssociations?: number; /** * Indicates whether to show arrows for connectivity associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsConnectivity Read more...} */ showArrowsConnectivity?: boolean; /** * Indicates whether to show arrows for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#showArrowsStructuralAttachment Read more...} */ showArrowsStructuralAttachment?: boolean; /** * A {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-symbols-SimpleLineSymbol.html SimpleLineSymbol} used for representing the polyline geometry that is being drawn for structural attachment associations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#structuralAttachmentAssociationsLineSymbol Read more...} */ structuralAttachmentAssociationsLineSymbol?: SimpleLineSymbolProperties; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view associated with the UtilityNetworkAssociations widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations-UtilityNetworkAssociationsViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#VisibleElements Read more...} */ export interface UtilityNetworkAssociationsVisibleElementsProperties { connectivityAssociationsSettings?: VisibleElementsConnectivityAssociationsSettingsProperties; maxAllowableAssociationsSlider?: boolean; structuralAttachmentAssociationsSettings?: VisibleElementsStructuralAttachmentAssociationsSettingsProperties; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkAssociations.html#VisibleElements Read more...} */ export interface UtilityNetworkAssociationsVisibleElements extends AnonymousAccessor { get connectivityAssociationsSettings(): VisibleElementsConnectivityAssociationsSettings; set connectivityAssociationsSettings(value: VisibleElementsConnectivityAssociationsSettingsProperties); get structuralAttachmentAssociationsSettings(): VisibleElementsStructuralAttachmentAssociationsSettings; set structuralAttachmentAssociationsSettings(value: VisibleElementsStructuralAttachmentAssociationsSettingsProperties); maxAllowableAssociationsSlider: boolean; } export interface VisibleElementsConnectivityAssociationsSettingsProperties { arrowsToggle?: boolean; capSelect?: boolean; colorPicker?: boolean; stylePicker?: boolean; widthInput?: boolean; } export interface VisibleElementsConnectivityAssociationsSettings extends AnonymousAccessor { arrowsToggle: boolean; capSelect: boolean; colorPicker: boolean; stylePicker: boolean; widthInput: boolean; } export interface VisibleElementsStructuralAttachmentAssociationsSettingsProperties { arrowsToggle?: boolean; capSelect?: boolean; colorPicker?: boolean; stylePicker?: boolean; widthInput?: boolean; } export interface VisibleElementsStructuralAttachmentAssociationsSettings extends AnonymousAccessor { arrowsToggle: boolean; capSelect: boolean; colorPicker: boolean; stylePicker: boolean; 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" * } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#defaultGraphicColor Read more...} */ defaultGraphicColor: GraphicColor; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#disabled Read more...} */ disabled: boolean; /** * When `true`, provides the ability to show the convex hull or buffer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#enableResultArea Read more...} */ enableResultArea: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#flags Read more...} */ flags: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * @deprecated since version 4.31, gdbVersion will be removed and the gdbVersion of the {@link module:geoscene/networks/UtilityNetwork} will be consumed directly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#gdbVersion Read more...} */ gdbVersion: string; /** * Icon displayed in the widget's button. * * @default "utility-network-trace" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#icon Read more...} */ icon: string; /** * Custom labels, descriptions, and symbol for the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#flags flags}. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#inputSettings Read more...} */ inputSettings: InputSetting[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#label Read more...} */ label: 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 * } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#resultAreaProperties Read more...} */ resultAreaProperties: ResultAreaPropertiesExtend; /** * A list of global Ids of traces to select on load. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#selectedTraces Read more...} */ selectedTraces: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#selectOnComplete Read more...} */ selectOnComplete: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#showGraphicsOnComplete Read more...} */ showGraphicsOnComplete: boolean; /** * Determines whether to show list of selection attributes. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#showSelectionAttributes Read more...} */ showSelectionAttributes: boolean; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#view Read more...} */ view: MapView | nullish; /** * The UtilityNetworkTrace widget provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html Read more...} */ constructor(properties?: UtilityNetworkTraceProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#viewModel Read more...} */ get viewModel(): UtilityNetworkTraceViewModel; set viewModel(value: UtilityNetworkTraceViewModelProperties); /** * Checks if the requirements to execute a trace are met. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#checkCanTrace Read more...} */ checkCanTrace(): Promise; /** * Prompts to clear all input flags, selected trace types, and the trace results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#confirmReset Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#defaultGraphicColor Read more...} */ defaultGraphicColor?: GraphicColor; /** * When true, the widget is visually withdrawn and cannot be interacted with. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#disabled Read more...} */ disabled?: boolean; /** * When `true`, provides the ability to show the convex hull or buffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#enableResultArea Read more...} */ enableResultArea?: boolean; /** * An array of map points to load into the widget to lookup flags. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#flags Read more...} */ flags?: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @deprecated since version 4.31, gdbVersion will be removed and the gdbVersion of the {@link module:geoscene/networks/UtilityNetwork} will be consumed directly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#gdbVersion Read more...} */ gdbVersion?: string; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#icon Read more...} */ icon?: string; /** * Custom labels, descriptions, and symbol for the input {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#flags flags}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#inputSettings Read more...} */ inputSettings?: InputSetting[]; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#label Read more...} */ label?: 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#resultAreaProperties Read more...} */ resultAreaProperties?: ResultAreaPropertiesExtend; /** * A list of global Ids of traces to select on load. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#selectedTraces Read more...} */ selectedTraces?: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#selectOnComplete Read more...} */ selectOnComplete?: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#showGraphicsOnComplete Read more...} */ showGraphicsOnComplete?: boolean; /** * Determines whether to show list of selection attributes. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#showSelectionAttributes Read more...} */ showSelectionAttributes?: boolean; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#viewModel Read more...} */ 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" * } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#defaultGraphicColor Read more...} */ defaultGraphicColor: GraphicColor; /** * When true, provides the ability to show the convex hull or buffer. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#enableResultArea Read more...} */ enableResultArea: boolean; /** * An array of map points to load into the widget to lookup flags. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#flags Read more...} */ flags: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @default "sde.DEFAULT" * @deprecated since version 4.31, gdbVersion will be removed and the gdbVersion of the {@link module:geoscene/networks/UtilityNetwork} will be consumed directly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#gdbVersion Read more...} */ gdbVersion: string; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#goToOverride Read more...} */ declare goToOverride: GoTo["goToOverride"]; /** * 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 * } * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#resultAreaProperties Read more...} */ resultAreaProperties: ResultAreaPropertiesExtend; /** * An array of global Ids of traces to select on initial load. * * @default [] * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectedTraces Read more...} */ selectedTraces: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectOnComplete Read more...} */ selectOnComplete: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showGraphicsOnComplete Read more...} */ showGraphicsOnComplete: boolean; /** * Determines whether to show the list of selected features from completed traces. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showSelectionAttributes Read more...} */ showSelectionAttributes: boolean; /** * The view model's state. * * @default "ready" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#state Read more...} */ readonly state: "loading" | "ready"; /** * Stores the result of completed traces. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#traceResults Read more...} */ traceResults: TraceResultExtend[]; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html UtilityNetworkTrace} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-utility-network-trace/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html Read more...} */ constructor(properties?: UtilityNetworkTraceViewModelProperties); /** * Adds a flag point graphic for the click event on the view if there is a feature to query. * * @param type The type of flag can be a `"starting point"` or a `"barrier"`. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addFlagByHit Read more...} */ addFlagByHit(type: string): Promise; /** * Creates a graphic from the trace result and adds it to the map. * * @param trace The aggregate of the trace configuration settings and the results for that trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addResultAreaToMap Read more...} */ addResultAreaToMap(trace: TraceResultExtend): void; /** * Create a graphic on the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#graphics graphics} for the aggregated results of all the features returned by the trace. * * @param trace The aggregate of the trace configuration settings and the results for that trace. * @param color The color for the graphic of the trace results in the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#graphics graphics}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addResultGraphicToView Read more...} */ addResultGraphicToView(trace: TraceResultExtend, color: GraphicColor): Promise; /** * Adds the selected terminal to a flag point. * * @param selectedTerminal The terminal id of the selected terminal. * @param feature The flag to assign the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#addTerminal Read more...} */ addTerminal(selectedTerminal: string, feature: FlagProperty): void; /** * Get all parameters for the trace type selected to be run before executing the trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#callTrace Read more...} */ callTrace(): Promise; /** * Change the graphic color for the aggregated results of a trace. * * @param color The color for the graphic of the trace results in the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#graphics graphics}. * @param trace The aggregate of the trace configuration settings and the results for that trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#changeResultGraphicColor Read more...} */ 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). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#checkCanTrace Read more...} */ checkCanTrace(): ValidSetup; /** * Indicates if any selection exists on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#checkSelectionExist Read more...} */ checkSelectionExist(): boolean; /** * Removes a specific trace from the results. * * @param trace The trace that will be cleared. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#clearResult Read more...} */ clearResult(trace: TraceItem): void; /** * Creates a buffer or convex hull graphic of the trace result. * * @param traceResults The aggregate of the trace configuration settings and the results for that trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#createResultAreaGraphic Read more...} */ createResultAreaGraphic(traceResults: TraceResultExtend): Promise; /** * Executes the trace and returns all trace results as graphics and/or feature selections and functions. * * @param traceItem The trace item input for the trace. * @param url The URL of the service being traced. * @param params The trace input parameters. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#executeTrace Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#getValidSources Read more...} */ getValidSources(): (EdgeSourceJSON | JunctionSourceJSON)[]; /** * Reads the web map and loads the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html UtilityNetwork} if it exists. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#loadUtilityNetwork Read more...} */ loadUtilityNetwork(): Promise; /** * Enables or disables the filter barrier setting on barrier flags. * * @param status Whether the filter barrier is enabled or disabled. * @param feature The barrier flag for which the filter barrier is enabled or disabled. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#manageFilterBarrier Read more...} */ manageFilterBarrier(status: boolean, feature: FlagProperty): void; /** * Is used to merge the feature selections in the layer views when multiple traces are run. * * @param status If true, the trace selection results are part of the merged selection set. * @param trace The trace for which the status is defined. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#mergeSelection Read more...} */ mergeSelection(status: boolean, trace: TraceItem): void; /** * Query the layers by ObjectID for more attributes not present on the trace result elements. * * @param dataItems An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html NetworkElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#queryFeaturesById Read more...} */ queryFeaturesById(dataItems: NetworkElement[]): Promise; /** * Takes the result of a hit test to lookup the asset to create a flag for the trace. * * @param event The create event. * @param flagType The type of flag. It must be either `"starting point"` or `"barrier"`. The `stopping-point` type is reserved for future use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#queryFlagByHitTest Read more...} */ queryFlagByHitTest(event: UtilityNetworkTraceViewModelQueryFlagByHitTestEvent, flagType: "starting-point" | "barrier" | "stopping-point"): Promise; /** * Removes all the graphics from the result area graphic layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeAllResultAreaGraphics Read more...} */ removeAllResultAreaGraphics(): void; /** * Removes the selected flag from the view. * * @param flag The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty FlagProperty} to identify the flag to be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeFlag Read more...} */ removeFlag(flag: FlagProperty): void; /** * Removes the result area graphic from the `Map`. * * @param trace The aggregate of the trace configuration settings and the results for that trace. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeResultAreaFromMap Read more...} */ removeResultAreaFromMap(trace: TraceResultExtend): void; /** * Removes a specific trace result graphic from the view's {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#graphics graphics}. * * @param trace The trace for which the graphic will be removed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeResultGraphicFromView Read more...} */ removeResultGraphicFromView(trace: TraceResultExtend): void; /** * Removes the selection from the layer view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeSelection Read more...} */ removeSelection(): void; /** * Removes the selected terminal from the flag. * * @param selectedTerminal The terminal id of the selected terminal. * @param feature The flag to remove the terminal. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#removeTerminal Read more...} */ removeTerminal(selectedTerminal: string, feature: FlagProperty): void; /** * Clears all inputs (flags, trace types) and all results (selections, graphics) in the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#reset Read more...} */ reset(): void; /** * Performs a selection on a layer view based on a list of ObjectIDs. * * @param resultSet An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html NetworkElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectFeaturesById Read more...} */ selectFeaturesById(resultSet: NetworkElement[]): void; /** * Loops through the trace result elements to group them by network source id and selects them on the layer view. * * @param resultSet An array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-networks-support-NetworkElement.html NetworkElements}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectResults Read more...} */ selectResults(resultSet: NetworkElement[]): void; /** * Set the trace type to be run from the available trace configurations in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap}. * * @param state This is `true` if the trace is selected. * @param traceId The globalid of the trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectTraces Read more...} */ selectTraces(state: boolean, traceId: string): void; /** * Preset a trace type to be run from the available {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-networks-UtilityNetwork.html#sharedNamedTraceConfigurations trace configurations} in the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-WebMap.html WebMap} when the widget loads. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectTracesOnLoad Read more...} */ selectTracesOnLoad(): void; /** * Zoom to a flag's feature or a result feature in the view. * * @param geometry The geometry to zoom to. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#zoomToAsset Read more...} */ zoomToAsset(geometry: GoToTarget2D | GoToTarget3D): void; } interface UtilityNetworkTraceViewModelProperties extends GoToProperties { /** * The default color to assign the aggregated geometry of a trace result. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#defaultGraphicColor Read more...} */ defaultGraphicColor?: GraphicColor; /** * When true, provides the ability to show the convex hull or buffer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#enableResultArea Read more...} */ enableResultArea?: boolean; /** * An array of map points to load into the widget to lookup flags. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#flags Read more...} */ flags?: FlagProperty[]; /** * The Geodatabase version to pass into the trace. * * @deprecated since version 4.31, gdbVersion will be removed and the gdbVersion of the {@link module:geoscene/networks/UtilityNetwork} will be consumed directly. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#gdbVersion Read more...} */ gdbVersion?: string; /** * This function provides the ability to override either the * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html#goTo MapView goTo()} or * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html#goTo SceneView goTo()} methods. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#goToOverride Read more...} */ goToOverride?: GoToProperties["goToOverride"]; /** * 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#resultAreaProperties Read more...} */ resultAreaProperties?: ResultAreaPropertiesExtend; /** * An array of global Ids of traces to select on initial load. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectedTraces Read more...} */ selectedTraces?: string[]; /** * When true, the utility network elements are selected in the view when traces are completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#selectOnComplete Read more...} */ selectOnComplete?: boolean; /** * When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showGraphicsOnComplete Read more...} */ showGraphicsOnComplete?: boolean; /** * Determines whether to show the list of selected features from completed traces. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#showSelectionAttributes Read more...} */ showSelectionAttributes?: boolean; /** * Stores the result of completed traces. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#traceResults Read more...} */ traceResults?: TraceResultExtend[]; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#view Read more...} */ view?: MapView | nullish; } /** * AssetGroupJSON represents the [asset group](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetGroupJSON Read more...} */ export interface AssetGroupJSON { assetGroupCode: number; assetGroupName?: string; assetTypes: AssetTypeJSON[]; } /** * AssetTypeJSON represents [asset type](https://pro.geoscene.cn/zh/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#AssetTypeJSON Read more...} */ export interface AssetTypeJSON { assetTypeCode: number; assetTypeName?: string; terminalConfigurationId?: number; } /** * DisplayField represents the attribute field used as a display label for flags and selected features. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#DisplayField Read more...} */ export interface DisplayField { field?: string | nullish; value: string; } /** * EdgeSourceJSON represents the line layers that participate in the utility network service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#EdgeSourceJSON Read more...} */ export interface EdgeSourceJSON { layerId: number; assetGroups: AssetGroupJSON[]; sourceId: number; } /** * FeatureSetInfo represents the information for the results in the featureset. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FeatureSetInfo Read more...} */ export interface FeatureSetInfo { layer: FeatureLayer | SubtypeGroupLayer; featureSet: FeatureSet; } /** * FlagProperty represents the properties to define each flag point (starting points and barriers). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#FlagProperty Read more...} */ export interface FlagProperty { allTerminals?: TerminalConfiguration | nullish; details?: any | nullish; displayValue?: DisplayField | nullish; id?: number | nullish; mapGraphic?: Graphic | nullish; mapPoint?: Point | nullish; selectedTerminals?: number[] | nullish; type: "starting-point" | "barrier" | "stopping-point"; } /** * GraphicColor represents the color for the trace result graphic in the graphics layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#GraphicColor Read more...} */ export interface GraphicColor { color: number[]; haloOpacity: number; hex: string; } /** * JunctionSourceJSON represents the point layers that participate in the utility network service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#JunctionSourceJSON Read more...} */ export interface JunctionSourceJSON { layerId: number; assetGroups: AssetGroupJSON[]; 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ResultAreaPropertiesExtend Read more...} */ export interface ResultAreaPropertiesExtend { type: "buffer" | "convexhull"; distance: number; unit: LengthUnit; areaUnit: AreaUnit; color: GraphicColor; show: boolean; } /** * TraceItem extends the named trace configuration and adds a property to manage the selection on the view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceItem Read more...} */ export interface TraceItem { selected?: boolean; } /** * TraceResultExtend organizes the results based on the trace configuration and the trace results. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#TraceResultExtend Read more...} */ export interface TraceResultExtend { trace: TraceItem; results: TraceResult | nullish; selectionEnabled: boolean; graphicEnabled: boolean; graphicColor: GraphicColor; status: string; } export interface UtilityNetworkTraceViewModelQueryFlagByHitTestEvent { graphic: Graphic | nullish; state: "start" | "active" | "complete" | "cancel"; tool: "point" | "multipoint" | "polyline" | "polygon" | "rectangle" | "circle" | "mesh"; toolEventInfo: CreateToolEventInfo | nullish; type: "create"; } /** * ValidSetup verifies whether a trace meets all the requirements before it can execute. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace-UtilityNetworkTraceViewModel.html#ValidSetup Read more...} */ export interface ValidSetup { status: boolean; 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 {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#flags flags} user interface (UI) in the UtilityNetworkTrace widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTrace.html#InputSetting Read more...} */ export interface InputSetting { type: string; label: string; description: string; symbol?: SimpleMarkerSymbol | PictureMarkerSymbol; } export interface UtilityNetworkTraceRemoveResultAreaEvent { graphic: Graphic; } export class UtilityNetworkTraceAnalysisViewModel { /** * Displays execution errors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#executionError Read more...} */ readonly executionError: "trace-error" | nullish; /** * Displays an error if loading fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#loadError Read more...} */ readonly loadError: | "no-user-type-extension" | "no-utility-network" | "no-view" | "sceneView-not-supported" | nullish; /** * The viewModel's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#state Read more...} */ readonly state: "disabled" | "executing" | "loading" | "ready"; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#view Read more...} */ view: MapView | nullish; constructor(properties?: any); /** * Method used to execute a trace using a named trace configuration. * * @param parameters The parameters used to execute a trace based using named trace configurations. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#executeNamedTraceConfiguration Read more...} */ executeNamedTraceConfiguration(parameters: NamedTraceConfigurationParameters): Promise; } /** * Object used to execute a trace using a named trace configuration. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkTraceAnalysis-UtilityNetworkTraceAnalysisViewModel.html#NamedTraceConfigurationParameters Read more...} */ export interface NamedTraceConfigurationParameters { namedTraceConfigurationGlobalId: string; outSpatialReference?: SpatialReference; traceLocations?: TraceLocation[]; } export class UtilityNetworkValidateTopology extends Widget { /** * Specifies the extent of the validation. * * @default "current" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#extentToValidate Read more...} */ extentToValidate: "current" | "entire"; /** * Icon displayed in the widget's button. * * @default "check-circle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#label Read more...} */ label: string; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#view Read more...} */ view: MapView | nullish; /** * The UtilityNetworkValidateTopology widget class, functioning as a part of the GeoScene Maps SDK for JavaScript, * simplifies the process of validating a DirtyArea within a utility network. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html Read more...} */ constructor(properties?: UtilityNetworkValidateTopologyProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#viewModel Read more...} */ get viewModel(): UtilityNetworkValidateTopologyViewModel; set viewModel(value: UtilityNetworkValidateTopologyViewModelProperties); } interface UtilityNetworkValidateTopologyProperties extends WidgetProperties { /** * Specifies the extent of the validation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#extentToValidate Read more...} */ extentToValidate?: "current" | "entire"; /** * Icon displayed in the widget's button. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#label Read more...} */ label?: string; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#view Read more...} */ view?: MapView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html#viewModel Read more...} */ viewModel?: UtilityNetworkValidateTopologyViewModelProperties; } export class UtilityNetworkValidateTopologyViewModel extends Accessor { /** * If the validation process fails, this property returns an error message. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#executionError Read more...} */ readonly executionError: string; /** * Specifies the extent of the validation. * * @default "current" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#extentToValidate Read more...} */ extentToValidate: "current" | "entire"; /** * The view model's state. * * @default "ready" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#state Read more...} */ readonly state: "disabled" | "executing" | "failed" | "loading" | "ready" | "success"; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#utilityNetwork Read more...} */ utilityNetwork: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#view Read more...} */ view: MapView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology.html UtilityNetworkValidateTopology} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-utility-network-validate-topology/ component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html Read more...} */ constructor(properties?: UtilityNetworkValidateTopologyViewModelProperties); /** * If an error occurs during during validation a loadError wil be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#loadErrors Read more...} */ get loadErrors(): Collection; set loadErrors(value: CollectionProperties); /** * Validates the network topology of the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#utilityNetwork utility network}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#validateTopology Read more...} */ validateTopology(): void; } interface UtilityNetworkValidateTopologyViewModelProperties { /** * Specifies the extent of the validation. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#extentToValidate Read more...} */ extentToValidate?: "current" | "entire"; /** * If an error occurs during during validation a loadError wil be displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#loadErrors Read more...} */ loadErrors?: CollectionProperties; /** * Determines the utility network to use. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#utilityNetwork Read more...} */ utilityNetwork?: UtilityNetwork | nullish; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-UtilityNetworkValidateTopology-UtilityNetworkValidateTopologyViewModel.html#view Read more...} */ view?: MapView | nullish; } export class ValuePicker extends Widget { /** * Returns `true` if the ValuePicker can be advanced to the next position. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canNext Read more...} */ canNext: boolean; /** * Returns `true` if the ValuePicker can be played. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canPlay Read more...} */ canPlay: boolean; /** * Returns `true` if the ValuePicker can moved to the previous item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canPrevious Read more...} */ canPrevious: boolean; /** * An optional caption that appears on the ValuePicker widget to give context for the user. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#caption Read more...} */ caption: string | nullish; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#disabled Read more...} */ disabled: boolean; /** * Icon which represents the widget. * * @default "list-rectangle" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#icon Read more...} */ icon: string; /** * Indicates if the widget should be orientated horizontally (default) or vertically. * * @default "horizontal" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#layout Read more...} */ layout: "horizontal" | "vertical"; /** * If true, playback will restart when it reaches the end. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#loop Read more...} */ loop: boolean; /** * The pause, in milliseconds between playback advancement. * * @default 1000 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#playRate Read more...} */ playRate: number; /** * The current value of the ValuePicker. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#values Read more...} */ values: number[] | string[] | any[] | nullish; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#visibleElements Read more...} */ visibleElements: ValuePickerVisibleElements; /** * ValuePicker is a widget that allows users to step or play through a list of values. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html Read more...} */ constructor(properties?: ValuePickerProperties); /** * An optional component for presenting and managing data. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#component Read more...} */ get component(): ValuePickerCollection | ValuePickerCombobox | ValuePickerLabel | ValuePickerSlider | nullish; set component(value: | (ValuePickerCollection & { type: "collection" }) | (ValuePickerCombobox & { type: "combobox" }) | (ValuePickerLabel & { type: "label" }) | (ValuePickerSlider & { type: "slider" }) | nullish); /** * Select the next value or advance to next. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#next Read more...} */ next(): void; /** * Pause playing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#pause Read more...} */ pause(): void; /** * Start playing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#play Read more...} */ play(): void; /** * Select the previous value. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#previous Read more...} */ 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canNext Read more...} */ canNext?: boolean; /** * Returns `true` if the ValuePicker can be played. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canPlay Read more...} */ canPlay?: boolean; /** * Returns `true` if the ValuePicker can moved to the previous item. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#canPrevious Read more...} */ canPrevious?: boolean; /** * An optional caption that appears on the ValuePicker widget to give context for the user. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#caption Read more...} */ caption?: string | nullish; /** * An optional component for presenting and managing data. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#component Read more...} */ component?: | (ValuePickerCollection & { type: "collection" }) | (ValuePickerCombobox & { type: "combobox" }) | (ValuePickerLabel & { type: "label" }) | (ValuePickerSlider & { type: "slider" }) | nullish; /** * When `true`, sets the widget to a disabled state so the user cannot interact with it. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#disabled Read more...} */ disabled?: boolean; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#icon Read more...} */ icon?: string; /** * Indicates if the widget should be orientated horizontally (default) or vertically. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#layout Read more...} */ layout?: "horizontal" | "vertical"; /** * If true, playback will restart when it reaches the end. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#loop Read more...} */ loop?: boolean; /** * The pause, in milliseconds between playback advancement. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#playRate Read more...} */ playRate?: number; /** * The current value of the ValuePicker. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#values Read more...} */ values?: number[] | string[] | any[] | nullish; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#visibleElements Read more...} */ visibleElements?: ValuePickerVisibleElements; } export class ValuePickerCollection { readonly type: "collection"; constructor(properties?: any); /** * A collection of values that can be navigated or animated with the play, next, and previous buttons on the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html ValuePicker} widget.. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCollection.html#collection Read more...} */ get collection(): Collection | nullish; set collection(value: CollectionProperties | nullish); } export class ValuePickerCombobox { /** * An array of combobox items. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCombobox.html#items Read more...} */ items: ComboboxItem[] | nullish; /** * Combobox label. * * @default "ValuePickerCombobox" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCombobox.html#label Read more...} */ label: string | nullish; /** * Combobox placeholder text. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCombobox.html#placeholder Read more...} */ placeholder: string | nullish; readonly type: "combobox"; constructor(properties?: any); } /** * Object used to define the combobox {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCombobox.html#items item}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerCombobox.html#ComboboxItem Read more...} */ export interface ComboboxItem { value: string; label: string; } export class ValuePickerLabel { /** * An array of label items. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerLabel.html#items Read more...} */ items: Labelitem[] | nullish; readonly type: "label"; constructor(properties?: any); } /** * Object used to define the label items. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerLabel.html#labelitem Read more...} */ export interface Labelitem { value: string; label: string; } export class ValuePickerSlider { /** * A function used to format labels. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#labelFormatFunction Read more...} */ labelFormatFunction: SliderLabelFormatter | nullish; /** * Slider tick labels. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#labels Read more...} */ labels: number[] | nullish; /** * The positions of major ticks. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#majorTicks Read more...} */ majorTicks: number[] | nullish; /** * The maximum possible data/thumb value of the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#max Read more...} */ max: number | nullish; /** * The minimum possible data/thumb value on the slider. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#min Read more...} */ min: number | nullish; /** * The positions of minor ticks. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#minorTicks Read more...} */ minorTicks: number[] | nullish; /** * When true, slider values will ascend right to left and bottom to top when horizontal and vertical respectively. * * @default false * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#reversed Read more...} */ reversed: boolean; /** * Positions along the slider that the thumb will snap to when interacted with. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#steps Read more...} */ steps: number[] | nullish; readonly type: "slider"; constructor(properties?: any); /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#visibleElements Read more...} */ get visibleElements(): ValuePickerSliderVisibleElements; set visibleElements(value: ValuePickerSliderVisibleElementsProperties); } /** * The visible elements that are displayed within the slider component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#VisibleElements Read more...} */ export interface ValuePickerSliderVisibleElementsProperties { thumbTooltip?: boolean; } /** * The visible elements that are displayed within the slider component. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker-ValuePickerSlider.html#VisibleElements Read more...} */ export interface ValuePickerSliderVisibleElements extends AnonymousAccessor { 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. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-ValuePicker.html#VisibleElements Read more...} */ export interface ValuePickerVisibleElements { nextButton?: boolean; playButton?: boolean; previousButton?: boolean; } export class VersionManagementViewModel extends Accessor { /** * Displays execution errors. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#executionError Read more...} */ readonly executionError: string | nullish; /** * A key-value pair of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle FeatureServiceResourcesBundle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#featureServiceLookup Read more...} */ featureServiceLookup: globalThis.Map; /** * Displays an error if loading fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#loadError Read more...} */ readonly loadError: string | nullish; /** * Map of Service URLs and enterprise versions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#serverVersionLookup Read more...} */ serverVersionLookup: globalThis.Map; /** * Map of Service URLs and service names. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#serviceNameLookup Read more...} */ serviceNameLookup: globalThis.Map; /** * The viewModel's state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#state Read more...} */ readonly state: "loading" | "failed" | "ready" | "disabled" | "success" | "executing"; /** * Map of Service URLs and logged in users. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#userLookup Read more...} */ userLookup: globalThis.Map; /** * This property determines if a user has version admin privileges. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionAdministratorLookup Read more...} */ versionAdministratorLookup: globalThis.Map; /** * A Map of current version identifiers keyed on the map service url. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionIdentifierLookup Read more...} */ versionIdentifierLookup: globalThis.Map; /** * Contains information about versions contained in version management service such as name, guid, etc. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionInfoLookup Read more...} */ versionInfoLookup: globalThis.Map; /** * This property contains metadata about the versioning state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versioningStateLookup Read more...} */ versioningStateLookup: globalThis.Map; versioningStates: Collection; /** * This property contains metadata about the version management service. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionManagementServiceLookup Read more...} */ versionManagementServiceLookup: globalThis.Map; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#view Read more...} */ view: MapView; /** * This class allows you to manage versions from a variety of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html feature services}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html Read more...} */ constructor(properties?: VersionManagementViewModelProperties); /** * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions. * * @param parameters Parameters used to alter a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#alterVersion Read more...} */ alterVersion(parameters: AlterVersionParameters): Promise; /** * Method used to change a version using a featureServerUrl, name, and guid of a version. * * @param featureServerUrl The url of a feature service. * @param toVersionName Incoming version name. * @param toVersionGuid Incoming version guid. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#changeVersion Read more...} */ changeVersion(featureServerUrl: string, toVersionName: string, toVersionGuid: string): Promise>; /** * Creates a new version given the following parameters. * * @param parameters Parameters used to create a new version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#createVersion Read more...} */ createVersion(parameters: CreateVersionParameters): Promise; /** * Deletes a version given the following parameters. * * @param featureServerUrl The url of a feature service. * @param versionName The name of the version that is to be deleted. * @param versionGuid The guid of the version that is to be deleted. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#deleteVersion Read more...} */ deleteVersion(featureServerUrl: string, versionName: string, versionGuid: string): Promise; /** * Returns all versions accessible to the currently logged-in user. * * @param featureServerUrl The url of a feature service. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#getVersionInfos Read more...} */ getVersionInfos(featureServerUrl: string): Promise; } interface VersionManagementViewModelProperties { /** * A key-value pair of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle FeatureServiceResourcesBundle}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#featureServiceLookup Read more...} */ featureServiceLookup?: globalThis.Map; /** * Map of Service URLs and enterprise versions. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#serverVersionLookup Read more...} */ serverVersionLookup?: globalThis.Map; /** * Map of Service URLs and service names. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#serviceNameLookup Read more...} */ serviceNameLookup?: globalThis.Map; /** * Map of Service URLs and logged in users. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#userLookup Read more...} */ userLookup?: globalThis.Map; /** * This property determines if a user has version admin privileges. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionAdministratorLookup Read more...} */ versionAdministratorLookup?: globalThis.Map; /** * A Map of current version identifiers keyed on the map service url. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionIdentifierLookup Read more...} */ versionIdentifierLookup?: globalThis.Map; /** * Contains information about versions contained in version management service such as name, guid, etc. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionInfoLookup Read more...} */ versionInfoLookup?: globalThis.Map; /** * This property contains metadata about the versioning state. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versioningStateLookup Read more...} */ versioningStateLookup?: globalThis.Map; versioningStates?: Collection; /** * This property contains metadata about the version management service. * * @deprecated since version 4.30. Use {@link module:geoscene/versionManagement/VersioningState} instead. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#versionManagementServiceLookup Read more...} */ versionManagementServiceLookup?: globalThis.Map; /** * The view from which the widget will operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#view Read more...} */ view?: MapView; } /** * Parameters used to alter a version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#AlterVersionParameters Read more...} */ export interface AlterVersionParameters { featureServerUrl: string; versionIdentifier: VersionIdentifier; ownerName?: string; versionName?: string; access?: "hidden" | "private" | "protected" | "public"; description?: string; } /** * Parameters used to create a new version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#CreateVersionParameters Read more...} */ export interface CreateVersionParameters { featureServerUrl: string; versionName: string; access: "hidden" | "private" | "protected" | "public"; description?: string; ownerName?: string; } /** * Contains {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-rest-featureService-FeatureService.html FeatureService} and array of {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-Layer.html Layer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#FeatureServiceResourcesBundle Read more...} */ export interface VersionManagementViewModelFeatureServiceResourcesBundle { featureService: FeatureService; layers: Layer[]; } /** * Contains info about a Version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfo Read more...} */ export interface VersionManagementViewModelVersionInfo { versionIdentifier: VersionIdentifier; description?: string; access?: "hidden" | "private" | "protected" | "public"; versionId?: string; creationDate?: number; } /** * This contains extended information about a given version. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VersionManagement-VersionManagementViewModel.html#VersionInfoExtendedJSON Read more...} */ export interface VersionManagementViewModelVersionInfoExtendedJSON { versionIdentifier: VersionManagementViewModelVersionInfoExtendedJSONVersionIdentifier; description?: string; access?: "hidden" | "private" | "protected" | "public"; versionId?: string; creationDate?: number; modifiedDate?: number; reconcileDate?: number; evaluationDate?: number; previousAncestorDate?: number; commonAncestorDate?: number; isBeingEdited?: boolean; isBeingRead?: boolean; hasConflicts?: boolean; hasUninspectedConflicts?: boolean; isLocked?: boolean; lockOwner?: string; lockDate?: number; } export interface VersionManagementViewModelVersionInfoExtendedJSONVersionIdentifier { name: string; guid: string; } export class VideoPlayer extends Widget { /** * Icon which represents the widget. * * @default "video-web" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#icon Read more...} */ icon: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to use as the data source for the video player. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#layer Read more...} */ layer: VideoLayer | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#view Read more...} */ view: MapView | nullish; /** * The VideoPlayer widget provides a user interface for interacting with a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html Read more...} */ constructor(properties?: VideoPlayerProperties); /** * The view model for the VideoPlayer widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#viewModel Read more...} */ get viewModel(): VideoPlayerViewModel; set viewModel(value: VideoPlayerViewModelProperties); } interface VideoPlayerProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#icon Read more...} */ icon?: string; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to use as the data source for the video player. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#layer Read more...} */ layer?: VideoLayer | nullish; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#view Read more...} */ view?: MapView | nullish; /** * The view model for the VideoPlayer widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html#viewModel Read more...} */ viewModel?: VideoPlayerViewModelProperties; } export class VideoPlayerViewModel extends Accessor { /** * The amount of the video layer that has been buffered, in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#buffered Read more...} */ readonly buffered: number; /** * The current time of the video layer, in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#currentTime Read more...} */ readonly currentTime: number; /** * The duration of the video layer, in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#duration Read more...} */ readonly duration: number; /** * Indicates whether the video layer has ended. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#ended Read more...} */ readonly ended: boolean; /** * Determines which telemetry elements to follow when the video layer is playing. * * @default "follow-both" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#followingMode Read more...} */ followingMode: "follow-sensor" | "follow-frame" | "follow-both" | "none"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to play. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#layer Read more...} */ layer: VideoLayer | nullish; /** * The metadata associated with the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#metadata Read more...} */ readonly metadata: any | nullish; /** * Indicates whether the video layer is playing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#playing Read more...} */ readonly playing: boolean; /** * The number of seconds to seek forward or backward when the user clicks the seek forward or seek backward buttons. * * @default 10 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekLength Read more...} */ seekLength: number; /** * The state of the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#state Read more...} */ readonly state: "can-play" | "not-ready" | "paused" | "playing" | "ready" | "waiting" | "data-loaded" | "error"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} in which the video layer is displayed. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#view Read more...} */ view: MapView | nullish; /** * The VideoPlayerViewModel class provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer.html VideoPlayer} widget and {@link https://doc.geoscene.cn/javascript/4.33/references/map-components/geoscene-video-player/ Video Player component}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html Read more...} */ constructor(properties?: VideoPlayerViewModelProperties); /** * Changes the color of the graphics drawn on the map to represent telemetry elements such as sensor location and frame. * * @param color The color of the graphics * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#changeGraphicsColor Read more...} */ changeGraphicsColor(color: Color): void; /** * Changes the playback speed of the video layer. * * @param speed The playback speed of the video. A value of 1.0 is normal speed, 0.5 is half speed, and 2.0 is double speed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#changePlaybackSpeed Read more...} */ changePlaybackSpeed(speed: number): void; /** * Pauses the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#pause Read more...} */ pause(): void; /** * Plays the video layer. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#play Read more...} */ play(): void; /** * Seeks the video layer backward by the number of seconds specified by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekLength seekLength} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekBackward Read more...} */ seekBackward(): void; /** * Seeks the video layer forward by the number of seconds specified by the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekLength seekLength} property. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekForward Read more...} */ seekForward(): void; /** * Seeks the video layer to the specified time. * * @param seekToTime The time to seek to, in seconds. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekTo Read more...} */ seekTo(seekToTime: number): void; /** * Seeks the video layer to the beginning. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekToBeginning Read more...} */ seekToBeginning(): void; /** * Seeks the video layer to the ending. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekToEnding Read more...} */ seekToEnding(): void; /** * Toggles the frame center display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleFrameCenterDisplay Read more...} */ toggleFrameCenterDisplay(): void; /** * Toggles the video frame image draped on the map. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleFrameDisplay Read more...} */ toggleFrameDisplay(): void; /** * Toggles the frame outline display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleFrameOutlineDisplay Read more...} */ toggleFrameOutlineDisplay(): void; /** * Toggles the sensor display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleSensorDisplay Read more...} */ toggleSensorDisplay(): void; /** * Toggles the sensor sight line display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleSensorSightLineDisplay Read more...} */ toggleSensorSightLineDisplay(): void; /** * Toggles the sensor trail display. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#toggleSensorTrailDisplay Read more...} */ toggleSensorTrailDisplay(): void; } interface VideoPlayerViewModelProperties { /** * Determines which telemetry elements to follow when the video layer is playing. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#followingMode Read more...} */ followingMode?: "follow-sensor" | "follow-frame" | "follow-both" | "none"; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-layers-VideoLayer.html VideoLayer} to play. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#layer Read more...} */ layer?: VideoLayer | nullish; /** * The number of seconds to seek forward or backward when the user clicks the seek forward or seek backward buttons. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#seekLength Read more...} */ seekLength?: number; /** * The {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} in which the video layer is displayed. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-VideoPlayer-VideoPlayerViewModel.html#view Read more...} */ view?: MapView | nullish; } export class Weather extends Widget { /** * Indicates the heading level to use for the title of the widget. * * @default 4 * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#headingLevel Read more...} */ headingLevel: number; /** * Icon which represents the widget. * * @default "partly-cloudy" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#label Read more...} */ label: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#view Read more...} */ view: SceneView | nullish; /** * The Weather widget provides an interface for easily selecting and configuring the * weather effects in a {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html Read more...} */ constructor(properties?: WeatherProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#viewModel Read more...} */ get viewModel(): WeatherViewModel; set viewModel(value: WeatherViewModelProperties); /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#visibleElements Read more...} */ get visibleElements(): WeatherVisibleElements; set visibleElements(value: WeatherVisibleElementsProperties); } interface WeatherProperties extends WidgetProperties { /** * Indicates the heading level to use for the title of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#headingLevel Read more...} */ headingLevel?: number; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#label Read more...} */ label?: string; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#view Read more...} */ view?: SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#viewModel Read more...} */ viewModel?: WeatherViewModelProperties; /** * This property provides the ability to display or hide the individual elements of the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#visibleElements Read more...} */ visibleElements?: WeatherVisibleElementsProperties; } 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" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather-WeatherViewModel.html#state Read more...} */ readonly state: "disabled" | "ready" | "error"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather-WeatherViewModel.html#view Read more...} */ view: SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html Weather} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather-WeatherViewModel.html Read more...} */ constructor(properties?: WeatherViewModelProperties); /** * Sets the weather to the specified type. * * @param type The weather to be selected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather-WeatherViewModel.html#setWeatherByType Read more...} */ setWeatherByType(type: "sunny" | "cloudy" | "rainy" | "snowy" | "foggy"): void; } interface WeatherViewModelProperties { /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-View.html View}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather-WeatherViewModel.html#view Read more...} */ view?: SceneView | nullish; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#VisibleElements Read more...} */ export interface WeatherVisibleElementsProperties { header?: boolean; } /** * The visible elements that are displayed within the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Weather.html#VisibleElements Read more...} */ export interface WeatherVisibleElements extends AnonymousAccessor { header: boolean; } export interface Widget extends Accessor, Evented { } export class Widget { /** * Icon which represents the widget. * * @default null * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#icon Read more...} */ icon: string | nullish; /** * The unique ID assigned to the widget when the widget is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#id Read more...} */ id: string; /** * The widget's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#label Read more...} */ label: string | nullish; /** * Indicates whether the widget is visible. * * @default true * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#visible Read more...} */ visible: boolean; /** * The base class for the SDK's out-of-the-box widgets. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html Read more...} */ constructor(properties?: WidgetProperties); /** * The ID or node representing the DOM element containing the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#container Read more...} */ get container(): HTMLElement | nullish; set container(value: HTMLElement | nullish | string); /** * A utility method used for building the value for a widget's `class` property. * * @param classNames The class names. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#classes Read more...} */ classes(...classNames: (string | string[] | any)[]): string; /** * Destroys the widget instance. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#destroy Read more...} */ destroy(): void; /** * Emits an event on the instance. * * @param type The name of the event. * @param event The event payload. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#emit Read more...} */ emit(type: string, event?: any): boolean; /** * Indicates whether there is an event listener on the instance that matches * the provided event name. * * @param type The name of the event. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#hasEventListener Read more...} */ hasEventListener(type: string): boolean; /** * `isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#isFulfilled Read more...} */ isFulfilled(): boolean; /** * `isRejected()` may be used to verify if creating an instance of the class is rejected. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#isRejected Read more...} */ isRejected(): boolean; /** * `isResolved()` may be used to verify if creating an instance of the class is resolved. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#isResolved Read more...} */ isResolved(): boolean; /** * Registers an event handler on the instance. * * @param type An {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#events-summary event} or an array of events to listen for. * @param listener The function to call when the event fires. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#on Read more...} */ on(type: string | string[], listener: EventHandler): IHandle; /** * Executes after widget is ready for rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#postInitialize Read more...} */ postInitialize(): void; /** * This method is implemented by subclasses for rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#render Read more...} */ render(): any; /** * Renders widget to the DOM immediately. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#renderNow Read more...} */ renderNow(): void; /** * Schedules widget rendering. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#scheduleRender Read more...} */ scheduleRender(): void; /** * `when()` may be leveraged once an instance of the class is created. * * @param callback The function to call when the promise resolves. * @param errback The function to execute when the promise fails. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#when Read more...} */ when(callback?: Function, errback?: Function): Promise; } interface WidgetProperties { /** * The ID or node representing the DOM element containing the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#container Read more...} */ container?: HTMLElement | nullish | string; /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#icon Read more...} */ icon?: string | nullish; /** * The unique ID assigned to the widget when the widget is created. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#id Read more...} */ id?: string; /** * The widget's label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#label Read more...} */ label?: string | nullish; /** * Indicates whether the widget is visible. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Widget.html#visible Read more...} */ visible?: boolean; } export class Zoom extends Widget { /** * Icon which represents the widget. * * @default "magnifying-glass-plus" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#icon Read more...} */ icon: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#label Read more...} */ label: string; /** * Determines the layout/orientation of the Zoom widget. * * @default "vertical" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#layout Read more...} */ layout: "vertical" | "horizontal"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#view Read more...} */ view: MapView | SceneView | nullish; /** * The Zoom widget allows users to zoom in/out within a view. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html Read more...} */ constructor(properties?: ZoomProperties); /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#viewModel Read more...} */ get viewModel(): ZoomViewModel; set viewModel(value: ZoomViewModelProperties); /** * Zooms the view in by an LOD factor of 0.5. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#zoomIn Read more...} */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#zoomOut Read more...} */ zoomOut(): void; } interface ZoomProperties extends WidgetProperties { /** * Icon which represents the widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#icon Read more...} */ icon?: string; /** * The widget's default label. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#label Read more...} */ label?: string; /** * Determines the layout/orientation of the Zoom widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#layout Read more...} */ layout?: "vertical" | "horizontal"; /** * A reference to the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-MapView.html MapView} or {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-views-SceneView.html SceneView}. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#view Read more...} */ view?: MapView | SceneView | nullish; /** * The view model for this widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html#viewModel Read more...} */ viewModel?: ZoomViewModelProperties; } export class ZoomViewModel extends Accessor { /** * Indicates if the view can zoom in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#canZoomIn Read more...} */ canZoomIn: boolean; /** * Indicates if the view can zoom out. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#canZoomOut Read more...} */ canZoomOut: boolean; /** * The current state of the widget. * * @default "disabled" * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#state Read more...} */ readonly state: "disabled" | "ready"; /** * The view from which to operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#view Read more...} */ view: MapView | SceneView | nullish; /** * Provides the logic for the {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom.html Zoom} widget. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html Read more...} */ constructor(properties?: ZoomViewModelProperties); /** * Zooms the view in by an LOD factor of 0.5. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#zoomIn Read more...} */ zoomIn(): void; /** * Zooms the view out by an LOD factor of 2. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#zoomOut Read more...} */ zoomOut(): void; } interface ZoomViewModelProperties { /** * Indicates if the view can zoom in. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#canZoomIn Read more...} */ canZoomIn?: boolean; /** * Indicates if the view can zoom out. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#canZoomOut Read more...} */ canZoomOut?: boolean; /** * The view from which to operate. * * {@link https://doc.geoscene.cn/javascript/4.33/api-reference/geoscene-widgets-Zoom-ZoomViewModel.html#view Read more...} */ view?: MapView | SceneView | nullish; } 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 OpenStreetMapLayerLayerviewCreateErrorEventHandler = ( event: OpenStreetMapLayerLayerviewCreateErrorEvent, ) => void; export type OpenStreetMapLayerLayerviewCreateEventHandler = (event: OpenStreetMapLayerLayerviewCreateEvent) => void; export type OpenStreetMapLayerLayerviewDestroyEventHandler = (event: OpenStreetMapLayerLayerviewDestroyEvent) => void; export type OpenStreetMapLayerRefreshEventHandler = (event: OpenStreetMapLayerRefreshEvent) => 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 VectorTileLayerLayerviewCreateErrorEventHandler = ( event: VectorTileLayerLayerviewCreateErrorEvent, ) => void; export type VectorTileLayerLayerviewCreateEventHandler = (event: VectorTileLayerLayerviewCreateEvent) => void; export type VectorTileLayerLayerviewDestroyEventHandler = (event: VectorTileLayerLayerviewDestroyEvent) => void; export type VectorTileLayerRefreshEventHandler = (event: VectorTileLayerRefreshEvent) => void; export type ViewAnalysisViewCreateErrorEventHandler = (event: ViewAnalysisViewCreateErrorEvent) => void; export type ViewAnalysisViewCreateEventHandler = (event: ViewAnalysisViewCreateEvent) => void; export type ViewAnalysisViewDestroyEventHandler = (event: ViewAnalysisViewDestroyEvent) => 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 WebTileLayerLayerviewCreateErrorEventHandler = (event: WebTileLayerLayerviewCreateErrorEvent) => void; export type WebTileLayerLayerviewCreateEventHandler = (event: WebTileLayerLayerviewCreateEvent) => void; export type WebTileLayerLayerviewDestroyEventHandler = (event: WebTileLayerLayerviewDestroyEvent) => void; export type WebTileLayerRefreshEventHandler = (event: WebTileLayerRefreshEvent) => 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ export enum ClippingType { /** * Intersect. */ Intersect = "Intersect", /** * Subtract. */ Subtract = "Subtract" } /** * Represents the text part position properties on a callout part. * * */ 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. * * */ 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. * * */ export enum FillMode { /** * Mosaic fill. */ Mosaic = "Mosaic", /** * Centered fill. */ Centered = "Centered" } /** * Represents the text part position properties on a callout part. * * */ 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. * * */ export enum FontEncoding { /** * Symbol encoding. */ MSSymbol = "MSSymbol", /** * Unicode. */ Unicode = "Unicode" } /** * Represents the text part position properties on a callout part. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ export enum VerticalGlyphOrientation { /** * Align right. */ Right = "Right", /** * Align upright. */ Upright = "Upright" } /** * Represents a water fill which fills polygonal geometry with animated water. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ export enum GradientStrokeMethod { /** * A gradient across the line. */ AcrossLine = "AcrossLine", /** * A gradient along the line. */ AlongLine = "AlongLine" } /** * Relative to the ground. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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 * * */ 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 * * */ 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 * * */ 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 * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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 * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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 * * */ export interface CIMFill extends CIMSymbolLayerBase { } /** * Represents a gradient fill which fills polygonal geometry with a specified color scheme. * * */ 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 * * */ 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. * * */ 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. * * */ 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 * * */ export interface CIMSymbolBase { type: string; } /** * 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. * * */ export interface CIMLineSymbol extends CIMMultiLayerSymbol { type: "CIMLineSymbol"; } /** * Represents a marker graphic which is used to define vector graphics in a vector marker. * * */ 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 * * */ export interface CIMMarkerPlacementBase { type: string; /** * The primitive name. */ primitiveName?: string; } /** * CIMMarkerStrokePlacement * * */ export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase { /** * A value indicating whether to angle the marker to the line. */ angleToLine?: boolean; /** * The offset. */ offset?: number; } /** * 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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 * * */ export interface CIMMarkerFillPlacement extends CIMMarkerPlacementBase { } /** * Represents marker placement inside a polygon which defines how a polygon is filled with a pattern of markers. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ export interface CIMPolygonSymbol extends CIMMultiLayerSymbol { type: "CIMPolygonSymbol"; } /** * Represents shape vertices. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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. * * */ 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; } }