OpenLayers 3

ol.control. ol.control.ScaleLine

new ScaleLine

Stability: experimental

Create a control to help users estimate distances on a map. By default it will show in the bottom left portion of the map, but it can be changed by using a css selector for .ol-scale-line.

Parameters:
Name Type Argument Description
options olx.control.ScaleLineOptions <optional>

Scale line options.

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:
  • scalelinecontrol.js, line 57
Fires:

Extends

Observable Properties

Name Type Settable ol.ObjectEvent type Description
units ol.control.ScaleLineUnits yes change:units the units to use in the scale line

Methods

bindTo

Stability: experimental

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );
Parameters:
Name Type Argument Description
key string

Key name.
target ol.Object

Target.
targetKey string <optional>

Target key.
Inherited From:
Source:
  • object.js, line 247
Returns:
Type
ol.ObjectAccessor

dispatchChangeEvent

Stability: experimental

Dispatches a change event. Register a listener for this event to get notified of changes.

Inherited From:
Source:
  • observable.js, line 39
Fires:
  • event:change

get

Stability: experimental

Gets a value.

Parameters:
Name Type Description
key string

Key name.
Inherited From:
Source:
  • object.js, line 304
Returns:

Value.

Type
*

getKeys

Stability: experimental

Get a list of object property names.

Inherited From:
Source:
  • object.js, line 332
Returns:

List of property names.

Type
Array.<string>

getMap

Stability: experimental

Get the map associated with this control.

Inherited From:
Source:
  • control.js, line 68
Returns:

Map.

Type
ol.Map

getProperties

Stability: experimental

Get an object of all property names and values.

Inherited From:
Source:
  • object.js, line 364
Returns:

Object.

Type
Object.<string, *>

getUnits

Stability: experimental
Source:
  • scalelinecontrol.js, line 143
Returns:

units.

Type
ol.control.ScaleLineUnits | undefined

notify

Stability: experimental

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Parameters:
Name Type Description
key string

Key name.
Inherited From:
Source:
  • object.js, line 384

on

Stability: experimental

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 61
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 74
Returns:

Unique key for the listener.

Type
goog.events.Key

set

Stability: experimental

Sets a value.

Parameters:
Name Type Description
key string

Key name.
value *

Value.
Inherited From:
Source:
  • object.js, line 415

setMap

Stability: stable

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.

Parameters:
Name Type Description
map ol.Map

Map.
Inherited From:
Source:
  • control.js, line 89

setUnits

Stability: experimental
Parameters:
Name Type Description
units ol.control.ScaleLineUnits

Units.
Source:
  • scalelinecontrol.js, line 179

setValues

Stability: experimental

Sets a collection of key-value pairs.

Parameters:
Name Type Description
values Object.<string, *>

Values.
Inherited From:
Source:
  • object.js, line 444

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 86

unbind

Stability: experimental

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Parameters:
Name Type Description
key string

Key name.
Inherited From:
Source:
  • object.js, line 458

unbindAll

Stability: experimental

Removes all bindings.

Inherited From:
Source:
  • object.js, line 482

unByKey

Stability: experimental

Removes an event listener using the key returned by on() or once().

Parameters:
Name Type Description
key goog.events.Key

Key.
Inherited From:
Source:
  • observable.js, line 96