OpenLayers 3

Class: ScaleLine

ol.control.ScaleLine

A control displaying rough x-axis distances, calculated for the center of the viewport. No scale line will be shown when the x-axis distance cannot be calculated in the view projection (e.g. at or beyond the poles in EPSG:4326). By default the scale line will show in the bottom left portion of the map, but this can be changed by using the css selector .ol-scale-line.

new ol.control.ScaleLine(opt_options)

src/ol/control/scalelinecontrol.js, line 54
Name Type Description
options

Scale line options.

Name Type Description
className string | undefined

CSS Class name. Default is ol-scale-line.
minWidth number | undefined

Minimum width in pixels. Default is 64.
render function | undefined experimental

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
target Element | undefined

Target.
units ol.control.ScaleLineUnits | string | undefined

Units. Default is metric.
Fires:

Extends

Observable Properties

Name Type Settable ol.ObjectEvent type Description
units ol.control.ScaleLineUnits | undefined yes change:units

The units to use in the scale line.

Methods

ol.control.ScaleLine.render(mapEvent) experimental

src/ol/control/scalelinecontrol.js, line 149

Update the scale line element.

This:
Name Type Description
mapEvent ol.MapEvent

Map event.

changed() inherited experimental

src/ol/observable.js, line 50

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 72

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event goog.events.EventLike

Event object.

get(key){*} inherited

src/ol/object.js, line 147

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 161

Get a list of object property names.

Returns:
List of property names.

getMap(){ol.Map} inherited

src/ol/control/control.js, line 94

Get the map associated with this control.

Returns:
Map.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 171

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 81

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getUnits(){ol.control.ScaleLineUnits|undefined}

src/ol/control/scalelinecontrol.js, line 137

Return the units to use in the scale line.

Returns:
The units to use in the scale line.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 94

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 107

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

set(key, value, opt_silent) inherited

src/ol/object.js, line 201

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setMap(map) inherited

src/ol/control/control.js, line 106

Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

Name Type Description
map ol.Map

Map.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 221

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean

Update without triggering an event.

setTarget(target) inherited experimental

src/ol/control/control.js, line 137

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Name Type Description
target Element | string

Target.

setUnits(units)

src/ol/control/scalelinecontrol.js, line 174

Set the units to use in the scale line.

Name Type Description
units ol.control.ScaleLineUnits

The units to use in the scale line.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 120

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 133

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

unset(key, opt_silent) inherited

src/ol/object.js, line 235

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.