Class MapViewCompat

constructor

• new MapViewCompat(options?): MapViewCompat

• Parameters

  • options: MapViewCompatOptions = {}

  Returns MapViewCompat

center

constraints

container

ReadonlyeventBus

extent

highlightOptions

loaded

loadStatus

map

padding

Readonlypopup

rotation

scale

spatialReference

Readonlyui

zoom

allLayerViews

• get allLayerViews(): readonly MapViewLayerViewCompat[]

• Returns all currently created layer views as a read-only collection.

  Returns readonly MapViewLayerViewCompat[]

closePopup

• closePopup(): void

• Returns void

destroy

• destroy(): void

• Returns void

emit

• emit(eventName, payload?): boolean

• Parameters

  • eventName: string
  • Optionalpayload: unknown

  Returns boolean

getLayerView

• getLayerView(layer): undefined | MapViewLayerViewCompat

• Returns an existing layer view for the given layer, or undefined if whenLayerView has not yet been called for it.

  Parameters

  • layer: unknown

  Returns undefined | MapViewLayerViewCompat

goTo

• goTo(target, options?): Promise<MapViewCompat>

• Parameters

  • target: MapViewGoToInput
  • options: MapViewGoToOptions = {}

  Returns Promise<MapViewCompat>

hitTest

• hitTest(event?): Promise<MapViewHitTestResult>

• Parameters

  • event: MapViewHitTestEvent = {}

  Returns Promise<MapViewHitTestResult>

load

• load(): Promise<MapViewCompat>

• Returns Promise<MapViewCompat>

on

• on(eventName, listener): MapViewHandle

• Parameters

  • eventName:
        | "click"
        | "double-click"
        | "pointer-move"
        | "pointer-down"
        | "pointer-up"
  • listener: ((event: MapViewScreenPoint & {
        mapPoint?: MapViewMapPoint;
        [key: string]: unknown;
    }) => void)
    • • (event): void

      • Parameters

        • event: MapViewScreenPoint & {
              mapPoint?: MapViewMapPoint;
              [key: string]: unknown;
          }

        Returns void

  Returns MapViewHandle

• on(eventName, listener): MapViewHandle

• Parameters

  • eventName: "layerview-create"
  • listener: ((event: {
        layer: unknown;
        layerView: MapViewLayerViewCompat;
    }) => void)
    • • (event): void

      • Parameters

        • event: {
              layer: unknown;
              layerView: MapViewLayerViewCompat;
          }

          • layer: unknown

          • layerView: MapViewLayerViewCompat

        Returns void

  Returns MapViewHandle

• on(eventName, listener): MapViewHandle

• Parameters

  • eventName: string
  • listener: ((event: unknown) => void)
    • • (event): void

      • Parameters

        • event: unknown

        Returns void

  Returns MapViewHandle

openPopup

• openPopup(options?): void

• Parameters

  • options: MapViewPopupOpenOptions = {}

  Returns void

setCenter

• setCenter(center): void

• Parameters

  • center: MapViewCenterLike

  Returns void

setConstraints

• setConstraints(constraints): void

• Parameters

  • constraints: MapViewConstraintsLike

  Returns void

setExtent

• setExtent(extent): void

• Parameters

  • extent: MapViewExtentLike

  Returns void

setHighlightOptions

• setHighlightOptions(highlightOptions): void

• Parameters

  • highlightOptions: MapViewHighlightOptionsLike

  Returns void

setPadding

• setPadding(padding): void

• Parameters

  • padding: MapViewPaddingLike

  Returns void

setRotation

• setRotation(rotation): void

• Parameters

  • rotation: undefined | number

  Returns void

setScale

• setScale(scale): void

• Parameters

  • scale: undefined | number

  Returns void

setSpatialReference

• setSpatialReference(spatialReference): void

• Parameters

  • spatialReference: MapViewSpatialReferenceLike

  Returns void

setZoom

• setZoom(zoom): void

• Parameters

  • zoom: undefined | number

  Returns void

takeScreenshot

• takeScreenshot(options?): Promise<MapViewTakeScreenshotResult>

• Parameters

  • options: MapViewTakeScreenshotOptions = {}

  Returns Promise<MapViewTakeScreenshotResult>

toMap

• toMap(screenPoint): MapViewMapPoint

• Parameters

  • screenPoint: MapViewScreenPoint

  Returns MapViewMapPoint

toScreen

• toScreen(mapPoint): MapViewScreenPoint

• Parameters

  • mapPoint: MapViewMapPoint

  Returns MapViewScreenPoint

watch

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "zoom"
  • listener: ((value: undefined | number) => void)
    • • (value): void

      • Parameters

        • value: undefined | number

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "scale"
  • listener: ((value: undefined | number) => void)
    • • (value): void

      • Parameters

        • value: undefined | number

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "rotation"
  • listener: ((value: undefined | number) => void)
    • • (value): void

      • Parameters

        • value: undefined | number

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "center"
  • listener: ((value: undefined | MapViewCenterLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewCenterLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "extent"
  • listener: ((value: undefined | MapViewExtentLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewExtentLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "loaded"
  • listener: ((value: boolean) => void)
    • • (value): void

      • Parameters

        • value: boolean

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "loadStatus"
  • listener: ((value: MapViewLoadStatusCompat) => void)
    • • (value): void

      • Parameters

        • value: MapViewLoadStatusCompat

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "container"
  • listener: ((value:
        | undefined
        | null
        | string
        | HTMLElement) => void)
    • • (value): void

      • Parameters

        • value:
              | undefined
              | null
              | string
              | HTMLElement

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "padding"
  • listener: ((value: undefined | MapViewPaddingLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewPaddingLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "constraints"
  • listener: ((value: undefined | MapViewConstraintsLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewConstraintsLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "highlightOptions"
  • listener: ((value: undefined | MapViewHighlightOptionsLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewHighlightOptionsLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "spatialReference"
  • listener: ((value: undefined | MapViewSpatialReferenceLike) => void)
    • • (value): void

      • Parameters

        • value: undefined | MapViewSpatialReferenceLike

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "allLayerViews"
  • listener: ((value: readonly MapViewLayerViewCompat[]) => void)
    • • (value): void

      • Parameters

        • value: readonly MapViewLayerViewCompat[]

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "popup.visible"
  • listener: ((value: boolean) => void)
    • • (value): void

      • Parameters

        • value: boolean

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "popup.viewModel.active"
  • listener: ((value: boolean) => void)
    • • (value): void

      • Parameters

        • value: boolean

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: "popup.selectedFeatureIndex"
  • listener: ((value: number) => void)
    • • (value): void

      • Parameters

        • value: number

        Returns void

  Returns MapViewHandle

• watch(propertyName, listener): MapViewHandle

• Parameters

  • propertyName: string
  • listener: ((value: unknown) => void)
    • • (value): void

      • Parameters

        • value: unknown

        Returns void

  Returns MapViewHandle

when

• when(callback?): Promise<MapViewCompat>

• Parameters

  • Optionalcallback: ((view: MapViewCompat) => void)
    • • (view): void

      • Parameters

        • view: MapViewCompat

        Returns void

  Returns Promise<MapViewCompat>

whenLayerView

• whenLayerView(layer): Promise<MapViewLayerViewCompat>

• Parameters

  • layer: unknown

  Returns Promise<MapViewLayerViewCompat>