BubbleLayerOptions interface

Package:

azure-maps-control

Options used when rendering Point objects in a BubbleLayer.

Extends

LayerOptions

Properties

blur	The amount to blur the circles. A value of 1 blurs the circles such that only the center point if at full opacity. Default 0.
color	The color to fill the circle symbol with. Default "#1A73AA".
opacity	A number between 0 and 1 that indicates the opacity at which the circles will be drawn. Default 1.
pitchAlignment	Specifies the orientation of circle when map is pitched. `"map"`: The circle is aligned to the plane of the map. `"viewport"`: The circle is aligned to the plane of the viewport. Default: `"viewport"`
radius	The radius of the circle symbols in pixels. Must be greater than or equal to 0. Default 8.
source	The id or instance of a data source which the layer will render.
sourceLayer	Required when the source of the layer is a VectorTileSource. A vector source can have multiple layers within it, this identifies which one to render in this layer. Prohibited for all other types of sources.
strokeColor	The color of the circles' outlines. Default "#FFFFFF".
strokeOpacity	A number between 0 and 1 that indicates the opacity at which the circles' outlines will be drawn. Default 1.
strokeWidth	The width of the circles' outlines in pixels. Default 2.

Inherited Properties

filter	An expression specifying conditions on source features. Only features that match the filter are displayed.
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.
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.
visible	Specifies if the layer is visible or not. Default true.

Property Details

blur

The amount to blur the circles. A value of 1 blurs the circles such that only the center point if at full opacity. Default 0.

blur?: number | DataDrivenPropertyValueSpecification<number>

Property Value

number | DataDrivenPropertyValueSpecification<number>

color

The color to fill the circle symbol with. Default "#1A73AA".

color?: string | DataDrivenPropertyValueSpecification<string>

Property Value

string | DataDrivenPropertyValueSpecification<string>

opacity

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

opacity?: number | DataDrivenPropertyValueSpecification<number>

Property Value

number | DataDrivenPropertyValueSpecification<number>

pitchAlignment

Specifies the orientation of circle when map is pitched.

`"map"`: The circle is aligned to the plane of the map.

`"viewport"`: The circle is aligned to the plane of the viewport.

Default: `"viewport"`

pitchAlignment?: "map" | "viewport"

Property Value

"map" | "viewport"

radius

The radius of the circle symbols in pixels. Must be greater than or equal to 0. Default 8.

radius?: number | DataDrivenPropertyValueSpecification<number>

Property Value

number | DataDrivenPropertyValueSpecification<number>

source

The id or instance of a data source which the layer will render.

source?: string | Source

Property Value

string | Source

sourceLayer

Required when the source of the layer is a VectorTileSource. A vector source can have multiple layers within it, this identifies which one to render in this layer. Prohibited for all other types of sources.

sourceLayer?: string

Property Value

string

strokeColor

The color of the circles' outlines. Default "#FFFFFF".

strokeColor?: string | DataDrivenPropertyValueSpecification<string>

Property Value

string | DataDrivenPropertyValueSpecification<string>

strokeOpacity

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

strokeOpacity?: number | DataDrivenPropertyValueSpecification<number>

Property Value

number | DataDrivenPropertyValueSpecification<number>

strokeWidth

The width of the circles' outlines in pixels. Default 2.

strokeWidth?: number | DataDrivenPropertyValueSpecification<number>

Property Value

number | DataDrivenPropertyValueSpecification<number>

Inherited Property Details

filter

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

filter?: Expression

Property Value

Expression

Inherited From LayerOptions.filter

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

Inherited From LayerOptions.maxZoom

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

Inherited From LayerOptions.minZoom

visible

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

visible?: boolean

Property Value

boolean

Inherited From LayerOptions.visible