Class MapViewCompat

constructor

• new MapViewCompat(options?: MapViewCompatOptions): MapViewCompat

  Parameters

  • options: MapViewCompatOptions = {}

  Returns MapViewCompat

constraints

container

ReadonlyeventBus

Readonlygraphics

highlightOptions

loaded

loadStatus

map

padding

Readonlypopup

popupEnabled

rotation

scale

spatialReference

Readonlyui

allLayerViews

• get allLayerViews(): readonly MapViewLayerViewCompat[]

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

  Returns readonly MapViewLayerViewCompat[]

center

• get center(): MapViewCenterLike | undefined

  Returns MapViewCenterLike | undefined

• set center(value: MapViewCenterLike | undefined): void

  Parameters

  • value: MapViewCenterLike | undefined

  Returns void

extent

• get extent(): MapViewExtentLike | undefined

  Returns MapViewExtentLike | undefined

• set extent(value: MapViewExtentLike | undefined): void

  Parameters

  • value: MapViewExtentLike | undefined

  Returns void

ready

• get ready(): boolean

  Esri view.ready. True once load has finished.

  Returns boolean

zoom

• get zoom(): number | undefined

  Returns number | undefined

• set zoom(value: number | undefined): void

  Parameters

  • value: number | undefined

  Returns void

addEventListener

• addEventListener(
      type: string,
      listener:
          | { handleEvent: (event: Event) => void }
          | ((event: unknown) => void),
  ): void

  Parameters

  • type: string
  • listener: { handleEvent: (event: Event) => void } | ((event: unknown) => void)

  Returns void

closePopup

• closePopup(): void

  Returns void

destroy

• destroy(): void

  Returns void

emit

• emit(eventName: string, payload?: unknown): boolean

  Parameters

  • eventName: string
  • Optionalpayload: unknown

  Returns boolean

getLayerView

• getLayerView(layer: unknown): MapViewLayerViewCompat | undefined

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

  Parameters

  • layer: unknown

  Returns MapViewLayerViewCompat | undefined

goTo

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

  Parameters

  • target: MapViewGoToInput
  • options: MapViewGoToOptions = {}

  Returns Promise<MapViewCompat>

hitTest

• hitTest(event?: MapViewHitTestEvent): Promise<MapViewHitTestResult>

  Parameters

  • event: MapViewHitTestEvent = {}

  Returns Promise<MapViewHitTestResult>

load

• load(): Promise<MapViewCompat>

  Returns Promise<MapViewCompat>

on

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

openPopup

• openPopup(options?: MapViewPopupOpenOptions): void

  Parameters

  • options: MapViewPopupOpenOptions = {}

  Returns void

removeEventListener

• removeEventListener(type: string, listener: (event: unknown) => void): void

  Parameters

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

  Returns void

setCenter

• setCenter(center: MapViewCenterLike | undefined): void

  Parameters

  • center: MapViewCenterLike | undefined

  Returns void

setConstraints

• setConstraints(constraints: MapViewConstraintsLike): void

  Parameters

  • constraints: MapViewConstraintsLike

  Returns void

setExtent

• setExtent(extent: MapViewExtentLike): void

  Parameters

  • extent: MapViewExtentLike

  Returns void

setHighlightOptions

• setHighlightOptions(highlightOptions: MapViewHighlightOptionsLike): void

  Parameters

  • highlightOptions: MapViewHighlightOptionsLike

  Returns void

setPadding

• setPadding(padding: MapViewPaddingLike): void

  Parameters

  • padding: MapViewPaddingLike

  Returns void

setRotation

• setRotation(rotation: number | undefined): void

  Parameters

  • rotation: number | undefined

  Returns void

setScale

• setScale(scale: number | undefined): void

  Parameters

  • scale: number | undefined

  Returns void

setSpatialReference

• setSpatialReference(spatialReference: MapViewSpatialReferenceLike): void

  Parameters

  • spatialReference: MapViewSpatialReferenceLike

  Returns void

setZoom

• setZoom(zoom: number | undefined): void

  Parameters

  • zoom: number | undefined

  Returns void

takeScreenshot

• takeScreenshot(
      options?: MapViewTakeScreenshotOptions,
  ): Promise<MapViewTakeScreenshotResult>

  Parameters

  • options: MapViewTakeScreenshotOptions = {}

  Returns Promise<MapViewTakeScreenshotResult>

toMap

• toMap(screenPoint: MapViewScreenPoint): MapViewMapPoint

  Parameters

  • screenPoint: MapViewScreenPoint

  Returns MapViewMapPoint

toScreen

• toScreen(mapPoint: MapViewMapPoint): MapViewScreenPoint

  Parameters

  • mapPoint: MapViewMapPoint

  Returns MapViewScreenPoint

watch

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

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

  Parameters

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

  Returns MapViewHandle

when

• when(callback?: (view: MapViewCompat) => void): Promise<MapViewCompat>

  Parameters

  • Optionalcallback: (view: MapViewCompat) => void

  Returns Promise<MapViewCompat>

whenLayerView

• whenLayerView(layer: unknown): Promise<MapViewLayerViewCompat>

  Parameters

  • layer: unknown

  Returns Promise<MapViewLayerViewCompat>