TypeDefs

AttributionOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is ol-attribution.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 27

ControlOptions

Stability: experimental

Properties:

Name	Type	Description
element	Element | undefined	The element is the control's container element. This only needs to be specified if you're developing a custom control.
target	Element | string | undefined	Specify a target if you want the control to be rendered outside of the map's viewport.

Source:

• objectliterals.jsdoc, line 29

DefaultsOptions

Stability: experimental

Properties:

Name	Type	Description
attribution	boolean | undefined	Attribution. Default is true.
attributionOptions	olx.control.AttributionOptions | undefined	Attribution options.
logo	boolean | undefined	Logo. Default is true.
logoOptions	olx.control.LogoOptions | undefined	Logo options.
zoom	boolean | undefined	Zoom. Default is true.
zoomOptions	olx.control.ZoomOptions | undefined	Zoom options.

Source:

• objectliterals.jsdoc, line 31

FullScreenOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is ol-full-screen.
tipLabel	string | undefined	Text label to use for the button tip. Default is Toggle full-screen
keys	boolean | undefined	Full keyboard access.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 33

LogoOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is ol-logo.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 35

MousePositionOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is ol-mouse-position.
coordinateFormat	ol.CoordinateFormatType | undefined	Coordinate format.
projection	ol.proj.ProjectionLike	Projection.
target	Element | undefined	Target.
undefinedHTML	string | undefined	Markup for undefined coordinates. Default is `` (empty string).

Source:

• objectliterals.jsdoc, line 37

ScaleLineOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS Class name. Default is ol-scale-line.
minWidth	number | undefined	Minimum width in pixels. Default is 64.
target	Element | undefined	Target.
units	ol.control.ScaleLineUnits | string | undefined	Units. Default is metric.

Source:

• objectliterals.jsdoc, line 39

ZoomOptions

Stability: experimental

Properties:

Name	Type	Description
duration	number | undefined	Animation duration in milliseconds. Default is 250.
className	string | undefined	CSS class name. Default is ol-zoom.
zoomInLabel	string | undefined	Text label to use for the zoom-in button. Default is +
zoomOutLabel	string | undefined	Text label to use for the zoom-out button. Default is -
zoomInTipLabel	string | undefined	Text label to use for the button tip. Default is Zoom in
zoomOutTipLabel	string | undefined	Text label to use for the button tip. Default is Zoom out
delta	number | undefined	The zoom delta applied on each click.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 41

ZoomSliderOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	CSS class name.
maxResolution	number | undefined	Maximum resolution.
minResolution	number | undefined	Minimum resolution.

Source:

• objectliterals.jsdoc, line 43

ZoomToExtentOptions

Stability: experimental

Properties:

Name	Type	Description
className	string | undefined	Class name. Default is ol-zoom-extent.
target	Element | undefined	Target.
tipLabel	string | undefined	Text label to use for the button tip. Default is Zoom to extent
extent	ol.Extent | undefined	The extent to zoom to. If undefined the validity extent of the view projection is used.

Source:

• objectliterals.jsdoc, line 45