Class CommonMapAPI

created

esriView

labelsDefault

name

viewPromise

• get viewPromise(): Promise<void>

  A promise that resolves when the map view has been created

  Returns Promise<void>

createMap

• createMap(
      config: RampMapConfig,
      targetDiv: string | HTMLDivElement,
  ): Promise<void>

  Will generate the actual Map control objects and construct it on the page

  Parameters

  • config: RampMapConfig

    the config for the map

  • targetDiv: string | HTMLDivElement

    the div to be used for the map view

  Returns Promise<void>

  resolves when the map has been created

getCurrentBasemapId

• getCurrentBasemapId(): string | undefined

  Get the id of the currently used basemap Returns undefined if there is no map

  Returns string | undefined

  current basemap id

getExtent

• getExtent(): Extent

  Provides the extent of the map

  Returns Extent

  the map extent in RAMP API Extent format

getExtentSet

• getExtentSet(): ExtentSet

  Provides the active extent set of the map

  Returns ExtentSet

  the active extent set of the map

getPixelHeight

• getPixelHeight(): number

  Get the height of the map on the screen in pixels

  Returns number

  pixel height

getPixelWidth

• getPixelWidth(): number

  Get the width of the map on the screen in pixels

  Returns number

  pixel width

getResolution

• getResolution(): number

  Provides the resolution of the map. This means the number of map units that is covered by one pixel.

  Returns number

  the map resolution

getScale

• getScale(): number

  Provides the scale of the map (the scale denominator as integer)

  Returns number

  the map scale

getSR

• getSR(): SpatialReference

  Provides the spatial reference of the map

  Returns SpatialReference

  the map spatial reference in RAMP API format

getZoomLevel

• getZoomLevel(): number

  Provides the zoom level of the map

  Returns number

  the map zoom level

recoverBasemap

• recoverBasemap(basemapSchemaId: string): Promise<void>

  Will attempt to change to another basemap if the very first basemap failed. If nothing is defined, will do nothing but manage our watching state.

  This method is overidden as needed

  Parameters

  • basemapSchemaId: string

    the basemap schema id (where the fallback is defined)

  Returns Promise<void>

  resolves after recovery has initiated

reloadMap

• reloadMap(
      config: RampMapConfig,
      targetDiv: string | HTMLDivElement,
  ): Promise<void>

  Reloads the map with the given map config and target div. This breaks down and re-creates the internal map state.

  Parameters

  • config: RampMapConfig

    the config for the map

  • targetDiv: string | HTMLDivElement

    the div to be used for the map view

  Returns Promise<void>

  resolves when the map has been re-created. Layers may still be loading.

AbstractsetBasemap

• setBasemap(basemapId: string): Promise<boolean>

  Set the map's basemap to the basemap with the given id. If the new basemap's tile schema differs from the current one, the map view will be refreshed

  The returned boolean indicates if the schema has changed.

  This method should be overidden by child map classes

  Parameters

  • basemapId: string

    the basemap id

  Returns Promise<boolean>

  resolves with boolean indicates if the schema has changed

setPointZoomScale

• setPointZoomScale(newScale: number): boolean

  Set's the map's pointZoomScale value to newScale. If newScale is not a positive number, a console error is thrown.

  The returned boolean indicates if the value has been successfully set.

  Parameters

  • newScale: number

    the new pointZoomScale value, which must be a positive number

  Returns boolean

  indicates if the value was set successfully

zoomMapTo

• zoomMapTo(
      geom: BaseGeometry,
      scale?: number,
      animate?: boolean,
      duration?: number,
      easing?: ZoomEasing,
  ): Promise<void>

  Zooms the map to a given geometry.

  Parameters

  • geom: BaseGeometry

    A RAMP API geometry to zoom the map to

  • Optionalscale: number

    An optional scale value of the map. Is ignored for non-Point geometries

  • Optionalanimate: boolean = true

    Option to turn off the zoom animation. On by default

  • Optionalduration: number = 200

    Option to change animation duration (in milliseconds). Default of 200. Ignored if animate is off.

  • Optionaleasing: ZoomEasing = 'ease'

    Option to change animation easing function. Default of 'ease'. Ignored if animate is off.

  Returns Promise<void>

  A promise that resolves when the map has finished zooming