ImageLayerOptions interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

azure-maps-control

Options used when rendering Point objects in a ImageLayer.

Extends

MediaLayerOptions

Properties

contrast	A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.
coordinates	An array of positions for the corners of the image listed in clockwise order: [top left, top right, bottom right, bottom left].
fadeDuration	The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.
filter	An expression specifying conditions on source features. Only features that match the filter are displayed.
hueRotation	Rotates hues around the color wheel. A number in degrees. Default 0.
maxBrightness	A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.
maxZoom	An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.
minBrightness	A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.
minZoom	An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.
opacity	A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.
saturation	A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.
url	URL to an image to overlay. Images hosted on other domains must have CORs enabled.
visible	Specifies if the layer is visible or not. Default true.

Property Details

contrast

A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.

contrast?: number

Property Value

number

coordinates

An array of positions for the corners of the image listed in clockwise order: [top left, top right, bottom right, bottom left].

coordinates?: Position[]

Property Value

Position[]

fadeDuration

The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.

fadeDuration?: number

Property Value

number

filter

An expression specifying conditions on source features. Only features that match the filter are displayed.

filter?: Expression

Property Value

Expression

hueRotation

Rotates hues around the color wheel. A number in degrees. Default 0.

hueRotation?: number

Property Value

number

maxBrightness

A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.

maxBrightness?: number

Property Value

number

maxZoom

An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.

maxZoom?: number

Property Value

number

minBrightness

A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.

minBrightness?: number

Property Value

number

minZoom

An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.

minZoom?: number

Property Value

number

opacity

A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.

opacity?: number

Property Value

number

saturation

A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.

saturation?: number

Property Value

number

url

URL to an image to overlay. Images hosted on other domains must have CORs enabled.

url?: string

Property Value

string

visible

Specifies if the layer is visible or not. Default true.

visible?: boolean

Property Value

boolean