TypeDefs

CircleOptions

Stability: experimental

Properties:

Name	Type	Description
fill	ol.style.Fill | undefined	Fill style.
radius	number	Circle radius.
stroke	ol.style.Stroke | undefined	Stroke style.

Source:

• olx.js, line 4395

FillOptions

Stability: experimental

Properties:

Name	Type	Description
color	ol.Color | string | undefined	Color.

Source:

• olx.js, line 4423

IconOptions

Stability: experimental

Properties:

Name	Type	Description
anchor	Array.<number> | undefined	Anchor. Default value is [0.5, 0.5] (icon center).
anchorOrigin	ol.style.IconAnchorOrigin | undefined	Origin of the anchor: bottom-left, bottom-right, top-left or top-right. Default is top-left.
anchorXUnits	ol.style.IconAnchorUnits | undefined	Units in which the anchor x value is specified. A value of 'fraction' indicates the x value is a fraction of the icon. A value of 'pixels' indicates the x value in pixels. Default is 'fraction'.
anchorYUnits	ol.style.IconAnchorUnits | undefined	Units in which the anchor y value is specified. A value of 'fraction' indicates the y value is a fraction of the icon. A value of 'pixels' indicates the y value in pixels. Default is 'fraction'.
crossOrigin	null | string | undefined	crossOrigin setting for image.
origin	Array.<number> | undefined	The top left corner, which, together with the size, define the sub-rectangle to use from the original icon image. Default value is [0, 0].
scale	number | undefined	Scale.
rotateWithView	boolean | undefined	Whether to rotate the icon with the view. Default is false.
rotation	number | undefined	Rotation.
size	ol.Size | undefined	Icon size in pixel.
src	string	Image source URI.

Source:

• olx.js, line 4447

StrokeOptions

Stability: experimental

Properties:

Name	Type	Description
color	ol.Color | string | undefined	Color.
lineCap	string | undefined	Line cap style: butt, round, or square. Default is round.
lineJoin	string | undefined	Line join style: bevel, round, or miter. Default is round.
lineDash	Array.<number> | undefined	Line dash pattern. Default is undefined (no dash).
miterLimit	number | undefined	Miter limit. Default is 10.
width	number | undefined	Width.

Source:

• olx.js, line 4543

StyleOptions

Stability: experimental

Properties:

Name	Type	Description
fill	ol.style.Fill | undefined	Fill style.
image	ol.style.Image | undefined	Image style.
stroke	ol.style.Stroke | undefined	Stroke style.
text	ol.style.Text | undefined	Text style.
zIndex	number | undefined	Z index.

Source:

• olx.js, line 4684

TextOptions

Stability: experimental

Properties:

Name	Type	Description
font	string | undefined	Font.
offsetX	number | undefined	Horizontal text offset in pixels. A positive will shift the text right. Default is 0.
offsetY	number | undefined	Vertical text offset in pixels. A positive will shift the text down. Default is 0.
scale	number | undefined	Scale.
rotation	number | undefined	Rotation.
text	string | undefined	Text.
textAlign	string | undefined	Text alignment.
textBaseline	string | undefined	Text base line.
fill	ol.style.Fill | undefined	Fill style.
stroke	ol.style.Stroke | undefined	Stroke style.

Source:

• olx.js, line 4601