Class EsriMapView

Hierarchy

  • View
  • BreakpointsOwner
    • EsriMapView

Constructors

  • A MapView displays a 2D view of a Map instance.

    Read more...

    Parameters

    • Optional properties: MapViewProperties

    Returns EsriMapView

Properties

allLayerViews: Collection<LayerView>

Collection containing a flat list of all the created LayerViews related to the basemap, operational layers, and group layers in this view.

Read more...

animation: ViewAnimation

Represents an ongoing view animation initialized by goTo().

Read more...

background: ColorBackground

The background color of the MapView.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#background)
basemapView: BasemapView

Represents the view for a single basemap after it has been added to the map.

Read more...

breakpoints: BreakpointsOwnerBreakpoints

A convenience property used for defining the breakpoints on the height and width of the view.

Read more...

center: EsriPoint

Represents the view's center point; when setting the center, you may pass a Point instance or an array of numbers representing a longitude/latitude pair ([-100.4593, 36.9014]).

Read more...

constraints: MapViewConstraints

Specifies constraints to scale, zoom, and rotation that may be applied to the MapView.

Read more...

container: HTMLDivElement

The id or node representing the DOM element containing the view.

Read more...

declaredClass: string
destroyed: boolean
extent: EsriExtent

The extent represents the visible portion of a map within the view as an instance of Extent.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent)
fatalError: Error

A fatal error returned when the view loses its WebGL context.

Read more...

floors: Collection<string>

Applies a display filter on the view for a specific set of floor levels.

Read more...

focused: boolean

Indicates if the browser focus is on the view.

Read more...

graphics: Collection<EsriGraphic>

Allows for adding graphics directly to the default graphics in the View.

Read more...

height: number

The height of the view in pixels read from the view container element.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#height)
heightBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"

A convenience property indicating the general size of the view's height.

Read more...

highlightOptions: HighlightOptions

Options for configuring the highlight.

Read more...

initialized: boolean
input: Input

Options to configure input handling of the View.

Read more...

interacting: boolean

Indication whether the view is being interacted with (for example when panning or by an interactive tool).

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#interacting)
layerViews: Collection<LayerView>

A collection containing a hierarchical list of all the created LayerViews of the operational layers in the map.

Read more...

magnifier: Magnifier

The magnifier allows for showing a portion of the view as a magnifier image on top of the view.

Read more...

map: EsriMap

An instance of a Map object to display in the view.

Read more...

navigating: boolean

Indication whether the view is being navigated (for example when panning).

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#navigating)
navigation: Navigation

Options to configure the navigation behavior of the View.

Read more...

orientation: "landscape" | "portrait"

A convenience property indicating the view's orientation.

Read more...

padding: ViewPadding

Use the padding property to make the center, and extent, etc.

Default

{left: 0, top: 0, right: 0, bottom: 0}

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding)
popup: Popup

A Popup object that displays general content or attributes from layers in the map.

Read more...

ready: boolean

When true, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#ready)
resizeAlign: "center" | "top" | "left" | "right" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

Defines which anchor stays still while resizing the browser window.

Default

center

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resizeAlign)
resizing: boolean

Indicates if the view is being resized.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#resizing)
resolution: number

Represents the current value of one pixel in the unit of the view's spatialReference.

Read more...

rotation: number

The clockwise rotation of due north in relation to the top of the view in degrees.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation)
scale: number

Represents the map scale at the center of the view.

Read more...

size: number[]

An array containing the width and height of the view in pixels, e.g.

Read more...

spatialReference: EsriSpatialReference

The spatial reference of the view.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference)
spatialReferenceLocked: boolean

Indicates if the MapView's spatialReference can be changed after it is initialized.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#spatialReferenceLocked)
stationary: boolean

Indication whether the view is animating, being navigated with or resizing.

Read more...

suspended: boolean

Indicates if the view is visible on the page.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#suspended)
timeExtent: TimeExtent

The view's time extent.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent)
type: "2d"

The dimension of the view.

Read more...

ui: DefaultUI

Exposes the default widgets available in the view and allows you to toggle them on and off.

Read more...

updating: boolean

Indicates whether the view is being updated by additional data requests to the network, or by processing received data.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#updating)
viewpoint: Viewpoint

Represents the current view as a Viewpoint or point of observation on the view.

Read more...

width: number

The width of the view in pixels read from the view container element.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-DOMContainer.html#width)
widthBreakpoint: "xsmall" | "small" | "medium" | "large" | "xlarge"

A convenience property indicating the general size of the view's width.

Read more...

zoom: number

Represents the level of detail (LOD) at the center of the view.

Read more...

Methods

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriMapView

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Destroys the view, and any associated resources, including its map, popup, and UI elements.

    Read more...

    Returns void

  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

  • Sets the focus on the view.

    Read more...

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

  • Sets the view to a given target.

    Read more...

    Parameters

    • target: any
    • Optional options: GoToOptions2D

    Returns Promise<any>

  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

  • Returns hit test results from each layer that intersects the specified screen coordinates.

    Read more...

    Parameters

    • screenPoint: MouseEvent | MapViewScreenPoint
    • Optional options: MapViewHitTestOptions

    Returns Promise<HitTestResult>

  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

  • Parameters

    • propertyName: string

    Returns void

  • Parameters

    • name: "resize"
    • eventHandler: ViewResizeEventHandler

    Returns IHandle

  • Parameters

    • name: "layerview-create"
    • eventHandler: ViewLayerviewCreateEventHandler

    Returns IHandle

  • Parameters

    • name: "layerview-create-error"
    • eventHandler: ViewLayerviewCreateErrorEventHandler

    Returns IHandle

  • Parameters

    • name: "layerview-destroy"
    • eventHandler: ViewLayerviewDestroyEventHandler

    Returns IHandle

  • Parameters

    • name: "click"
    • eventHandler: ViewClickEventHandler

    Returns IHandle

  • Parameters

    • name: "click"
    • modifiers: string[]
    • eventHandler: ViewClickEventHandler

    Returns IHandle

  • Parameters

    • name: "double-click"
    • eventHandler: ViewDoubleClickEventHandler

    Returns IHandle

  • Parameters

    • name: "double-click"
    • modifiers: string[]
    • eventHandler: ViewDoubleClickEventHandler

    Returns IHandle

  • Parameters

    • name: "immediate-double-click"
    • eventHandler: ViewImmediateDoubleClickEventHandler

    Returns IHandle

  • Parameters

    • name: "immediate-double-click"
    • modifiers: string[]
    • eventHandler: ViewImmediateDoubleClickEventHandler

    Returns IHandle

  • Parameters

    • name: "immediate-click"
    • eventHandler: ViewImmediateClickEventHandler

    Returns IHandle

  • Parameters

    • name: "immediate-click"
    • modifiers: string[]
    • eventHandler: ViewImmediateClickEventHandler

    Returns IHandle

  • Parameters

    • name: "hold"
    • eventHandler: ViewHoldEventHandler

    Returns IHandle

  • Parameters

    • name: "hold"
    • modifiers: string[]
    • eventHandler: ViewHoldEventHandler

    Returns IHandle

  • Parameters

    • name: "drag"
    • eventHandler: ViewDragEventHandler

    Returns IHandle

  • Parameters

    • name: "drag"
    • modifiers: string[]
    • eventHandler: ViewDragEventHandler

    Returns IHandle

  • Parameters

    • name: "mouse-wheel"
    • eventHandler: ViewMouseWheelEventHandler

    Returns IHandle

  • Parameters

    • name: "mouse-wheel"
    • modifiers: string[]
    • eventHandler: ViewMouseWheelEventHandler

    Returns IHandle

  • Parameters

    • name: "key-down"
    • eventHandler: ViewKeyDownEventHandler

    Returns IHandle

  • Parameters

    • name: "key-down"
    • modifiers: string[]
    • eventHandler: ViewKeyDownEventHandler

    Returns IHandle

  • Parameters

    • name: "key-up"
    • eventHandler: ViewKeyUpEventHandler

    Returns IHandle

  • Parameters

    • name: "key-up"
    • modifiers: string[]
    • eventHandler: ViewKeyUpEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-down"
    • eventHandler: ViewPointerDownEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-down"
    • modifiers: string[]
    • eventHandler: ViewPointerDownEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-move"
    • eventHandler: ViewPointerMoveEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-move"
    • modifiers: string[]
    • eventHandler: ViewPointerMoveEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-up"
    • eventHandler: ViewPointerUpEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-up"
    • modifiers: string[]
    • eventHandler: ViewPointerUpEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-enter"
    • eventHandler: ViewPointerEnterEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-enter"
    • modifiers: string[]
    • eventHandler: ViewPointerEnterEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-leave"
    • eventHandler: ViewPointerLeaveEventHandler

    Returns IHandle

  • Parameters

    • name: "pointer-leave"
    • modifiers: string[]
    • eventHandler: ViewPointerLeaveEventHandler

    Returns IHandle

  • Parameters

    • name: "focus"
    • eventHandler: ViewFocusEventHandler

    Returns IHandle

  • Parameters

    • name: "blur"
    • eventHandler: ViewBlurEventHandler

    Returns IHandle

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriMapView

  • Parameters

    • props: HashMap<any>

    Returns EsriMapView

  • Create a screenshot of the current view.

    Read more...

    Parameters

    • Optional options: MapViewTakeScreenshotOptions

    Returns Promise<Screenshot>

  • Converts the given screen point to a map point.

    Read more...

    Parameters

    • screenPoint: MouseEvent | MapViewScreenPoint

    Returns EsriPoint

  • Converts the given map point to a screen point.

    Read more...

    Parameters

    Returns MapViewScreenPoint

  • Call this method to clear any fatal errors resulting from a lost WebGL context.

    Read more...

    Returns void

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: PointCloudLayer

    Returns Promise<PointCloudLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: StreamLayer

    Returns Promise<StreamLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<FeatureLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: CSVLayer

    Returns Promise<CSVLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: GeoJSONLayer

    Returns Promise<GeoJSONLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: GeoRSSLayer

    Returns Promise<GeoRSSLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<GraphicsLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<ImageryLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: KMLLayer

    Returns Promise<KMLLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: SceneLayer

    Returns Promise<SceneLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: DimensionLayer

    Returns Promise<DimensionLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    • layer: Layer

    Returns Promise<LayerView>

Generated using TypeDoc