Classes

ol.control.Attribution

ol.control.Control

ol.control.FullScreen

ol.control.Logo

ol.control.MousePosition

ol.control.ScaleLine

ol.control.Zoom

ol.control.ZoomSlider

ol.control.ZoomToExtent

Members

<static> ScaleLineUnits :string

Properties:

Name	Type	Default	Description
DEGREES	string	degrees
IMPERIAL	string	imperial
NAUTICAL	string	nautical
METRIC	string	metric
US	string	us

Source:

• scalelinecontrol.js, line 33

Methods

<static> defaults

Parameters:

Name	Type	Argument	Description
options	ol.control.DefaultsOptions	<optional>	(Optional) Defaults options.
controls	Array.<ol.control.Control>=	<optional>	(Optional) Additional controls.

Source:

• controldefaults.js, line 14

Returns:

Controls.

Type

ol.Collection

TypeDefs

AttributionOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 27

ControlOptions

Properties:

Name	Type	Description
element	Element | undefined	Element.
map	ol.Map | undefined	Map.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 29

DefaultsOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 31

FullScreenOptions

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is 'ol-full-screen'.
keys	boolean | undefined	Full keyboard access.
map	ol.Map | undefined	Map.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 33

LogoOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 35

MousePositionOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 37

ScaleLineOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 39

ZoomOptions

Properties:

Name	Type	Description
className	string | undefined	CSS class name. Default is 'ol-zoom'.
delta	number | undefined	The zoom delta applied on each click.
map	ol.Map | undefined	Map.
target	Element | undefined	Target.

Source:

• objectliterals.jsdoc, line 41

ZoomSliderOptions

Properties:

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

Source:

• objectliterals.jsdoc, line 43

ZoomToExtentOptions

Properties:

Name	Type	Description
className	string | undefined	Class name.
map	ol.Map | undefined	Map.
target	Element | undefined	Target.
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