Class EsriOpenStreetMapLayer

Hierarchy

  • WebTileLayer
    • EsriOpenStreetMapLayer

Constructors

constructor

Properties

blendMode copyright declaredClass destroyed effect fullExtent id initialized listMode loadError loadStatus loadWarnings loaded maxScale minScale opacity portalItem refreshInterval spatialReference subDomains tileInfo tileServers title type urlTemplate visible

Methods

_get _set addHandles cancelLoad createLayerView destroy emit fetchAttributionData fetchTile get getTileUrl hasEventListener hasHandles isFulfilled isRejected isResolved load notifyChange on own refresh removeHandles set watch when fromJSON

Constructors

constructor

Properties

blendMode

blendMode: "screen" | "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" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"

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

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode)

copyright

copyright: string

The attribution information for the layer.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

effect

effect: Effect

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

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#effect)

fullExtent

fullExtent: EsriExtent

The full extent of the layer.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

listMode

listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Default

"show"

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode)

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError)

Readonly loadStatus

loadStatus: "loaded" | "loading" | "not-loaded" | "failed"

Represents the status of a load operation.

Default

not-loaded

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus)

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#loaded)

maxScale

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale)

minScale

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale)

opacity

opacity: number

The opacity of the layer.

Default

1

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity)

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval)

Readonly spatialReference

spatialReference: EsriSpatialReference

The spatial reference of the layer.

Default

Web Mercator Auxiliary Sphere (wkid: 3857)

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#spatialReference)

subDomains

subDomains: string[]

A string of subDomain names where tiles are served to speed up tile retrieval.

Read more...

tileInfo

tileInfo: TileInfo

The tiling scheme information for the layer.

Read more...

Readonly tileServers

tileServers: string[]

The list of tile server urls for the layer.

Read more...

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

Read more...

Readonly type

type: "open-street-map"

urlTemplate

urlTemplate: string

The url template is a string that specifies the URL of the hosted tile images to load.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible)

Methods

Protected _get

  • _get(propertyName): any

  • Parameters

    • propertyName: string

    Returns any

  • _get<T>(propertyName): T

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName, value): EsriOpenStreetMapLayer

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriOpenStreetMapLayer

addHandles

  • Type Parameters

    • T

    Parameters

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

    Returns void

cancelLoad

  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

createLayerView

  • Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

    Read more...

    Parameters

    • view: any
    • Optional options: LayerCreateLayerViewOptions

    Returns Promise<LayerView>

destroy

  • Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

    Read more...

    Returns void

emit

  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

  • Fetches custom attribution data for the layer when it becomes available.

    Read more...

    Returns Promise<any>

fetchTile

  • This method fetches a tile for the given level, row and column present in the view.

    Read more...

    Parameters

    • level: number
    • row: number
    • column: number
    • Optional options: WebTileLayerFetchTileOptions

    Returns Promise<HTMLImageElement>

get

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getTileUrl

  • This method returns a URL to a tile for a given level, row and column.

    Read more...

    Parameters

    • level: number
    • row: number
    • col: number

    Returns string

hasEventListener

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

    Read more...

    Parameters

    • type: string

    Returns boolean

hasHandles

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

isFulfilled

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

    Read more...

    Returns boolean

isRejected

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

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

    Returns IHandle

  • Parameters

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

    Returns IHandle

  • Parameters

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

    Returns IHandle

own

  • Deprecated

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

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

refresh

  • Fetches all the data for the layer.

    Read more...

    Returns void

removeHandles

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

set

watch

  • Parameters

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

    Returns WatchHandle

when

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

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Static fromJSON

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc