Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TileLayer

Hierarchy

Index

Properties

Readonly allSublayers

allSublayers: Collection<Sublayer>

A flat Collection of all the sublayers in the TileLayer including the sublayers of its sublayers.

Read more...

apiKey

apiKey: string

An authorization string used to access a resource or service.

Read more...

Readonly attributionDataUrl

attributionDataUrl: string

The URL that points to the location of the layer's attribution data.

Read more...

blendMode

blendMode: "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" | "screen" | "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.

Read more...

Readonly capabilities

Indicates the layer's supported capabilities.

Read more...

copyright

copyright: string

The copyright text as defined by the service.

Read more...

customParameters

customParameters: any

A list of custom parameters appended to the URL of all resources fetched by 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.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

Readonly hasAttributionData

hasAttributionData: boolean

Indicates if the layer has attribution data.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

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

Represents the status of a load operation.

Read more...

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.

Read more...

maxScale

maxScale: number

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

Read more...

minScale

minScale: number

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

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

refreshInterval

refreshInterval: number

Refresh interval of the layer in minutes.

Read more...

resampling

resampling: boolean

Resampling is enabled by default in 2D MapView and 3D SceneView.

Read more...

sourceJSON

sourceJSON: any

The tiled map service's metadata JSON exposed by the ArcGIS REST API.

Read more...

Readonly spatialReference

spatialReference: SpatialReference

The spatial reference of the layer as defined by the service.

Read more...

Readonly sublayers

sublayers: Collection<Sublayer>

tileInfo

tileInfo: TileInfo

Contains information about the tiling scheme for the layer.

Read more...

tileServers

tileServers: string[]

An array of tile servers used for changing map tiles.

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: "tile"

url

url: string

The URL of the REST endpoint of the layer.

Read more...

Readonly version

version: number

The version of ArcGIS Server in which the map service is published.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): TileLayer
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TileLayer

cancelLoad

  • cancelLoad(): void
  • 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

    Returns Promise<LayerView>

createServiceSublayers

  • Returns a deep clone of a map service's sublayers as defined by the service.

    Read more...

    Returns Collection<any>

destroy

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

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

  • fetchAttributionData(): Promise<any>
  • 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

    Returns Promise<HTMLImageElement>

findSublayerById

  • findSublayerById(id: number): any
  • Returns the sublayer with the given layerId.

    Read more...

    Parameters

    • id: number

    Returns any

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getTileUrl

  • getTileUrl(level: number, row: number, col: number): string
  • 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

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • 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(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

refresh

  • refresh(): void
  • Fetches all the data for the layer.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TileLayer

  • Parameters

    Returns TileLayer

watch

  • Parameters

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

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc