Class EsriMapImageLayer

Hierarchy

  • Layer
  • SublayersOwner
  • ArcGISMapService
  • ScaleRangeLayer
  • RefreshableLayer
  • TemporalLayer
  • BlendLayer
  • CustomParametersMixin
    • EsriMapImageLayer

Constructors

constructor

Properties

allSublayers blendMode capabilities copyright customParameters datesInUnknownTimezone declaredClass destroyed dpi effect fullExtent gdbVersion id imageFormat imageMaxHeight imageMaxWidth imageTransparency initialized legendEnabled listMode loadError loadStatus loadWarnings loaded maxScale minScale opacity portalItem refreshInterval sourceJSON spatialReference sublayers timeExtent timeInfo timeOffset title type url useViewTime version visible

Methods

_get _set addHandles cancelLoad createExportImageParameters createLayerView createServiceSublayers destroy emit fetchAttributionData fetchImage findSublayerById get hasEventListener hasHandles isFulfilled isRejected isResolved load loadAll notifyChange on own refresh removeHandles set watch when fromJSON

Constructors

constructor

  • MapImageLayer allows you to display and analyze data from sublayers defined in a map service, exporting images instead of features.

    Read more...

    Parameters

    • Optional properties: MapImageLayerProperties

    Returns EsriMapImageLayer

Properties

Readonly allSublayers

allSublayers: Collection<EsriSublayer>

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

Read more...

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)

Readonly capabilities

capabilities: ArcGISMapServiceCapabilities

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...

Readonly datesInUnknownTimezone

datesInUnknownTimezone: boolean

This property is set by the service publisher and indicates that dates should be considered without the local timezone.

Default

false

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

declaredClass

declaredClass: string

destroyed

destroyed: boolean

dpi

dpi: number

The output dots per inch (DPI) of the MapImageLayer.

Default

96

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

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...

gdbVersion

gdbVersion: string

The version of the geodatabase of the map service data.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

imageFormat

imageFormat: "png" | "png8" | "png24" | "png32" | "jpg" | "bmp" | "gif" | "pdf" | "svg" | "pngjpg"

The output image type.

Default

png24

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

imageMaxHeight

imageMaxHeight: number

Indicates the maximum height of the image exported by the service.

Default

2048

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

imageMaxWidth

imageMaxWidth: number

Indicates the maximum width of the image exported by the service.

Default

2048

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

imageTransparency

imageTransparency: boolean

Indicates whether the background of the image exported by the service is transparent.

Default

true

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

initialized

initialized: boolean

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Default

true

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

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)

sourceJSON

sourceJSON: any

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

Read more...

Readonly spatialReference

spatialReference: EsriSpatialReference

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

Read more...

sublayers

sublayers: Collection<EsriSublayer>

A Collection of Sublayer objects that allow you to alter the properties of one or more sublayers of the MapImageLayer.

Read more...

timeExtent

timeExtent: TimeExtent

The layer's time extent.

Default

null

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

timeInfo

timeInfo: TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

Default

null

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

timeOffset

timeOffset: TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

Default

null

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

title

title: string

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

Read more...

Readonly type

type: "map-image"

url

url: string

The URL to the REST endpoint of the map service.

Read more...

useViewTime

useViewTime: boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

Default

true

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

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.

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): EsriMapImageLayer

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriMapImageLayer

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

createExportImageParameters

  • Gets the parameters of the exported image to use when calling the export REST operation.

    Read more...

    Parameters

    • extent: EsriExtent
    • width: number
    • height: number
    • Optional options: MapImageLayerCreateExportImageParametersOptions

    Returns any

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>

createServiceSublayers

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

    Read more...

    Returns Collection<EsriSublayer>

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>

fetchImage

  • This method fetches the image for the specified extent and size.

    Read more...

    Parameters

    • extent: EsriExtent
    • width: number
    • height: number
    • Optional options: MapImageLayerFetchImageOptions

    Returns Promise<HTMLImageElement>

findSublayerById

  • Returns the sublayer with the given layerId.

    Read more...

    Parameters

    • id: number

    Returns EsriSublayer

get

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

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>

loadAll

Protected notifyChange

  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    • name: "refresh"
    • eventHandler: MapImageLayerRefreshEventHandler

    Returns IHandle

  • Parameters

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

    Returns IHandle

  • Parameters

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

    Returns IHandle

  • Parameters

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

    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

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriMapImageLayer

  • Parameters

    • props: HashMap<any>

    Returns EsriMapImageLayer

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