OpenLayers v4.0.1 API - Namespace: control

# Namespace: control

This documentation is for OpenLayers v4.0.1. The latest is v.

## olx.control

### Type Definitions

#### olx.control.AttributionOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS class name. Default is `ol-attribution`.
  `target` | Element | undefined | <optional> | Target.
  `collapsible` | boolean | undefined | <optional> | Specify if attributions can be collapsed. If you use an OSM source, should be set to `false` — see OSM Copyright — Default is `true`.
  `collapsed` | boolean | undefined | <optional> | Specify if attributions should be collapsed at startup. Default is `true`.
  `tipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Attributions`
  `label` | string | Node | undefined | <optional> | Text label to use for the collapsed attributions button. Default is `i`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `collapseLabel` | string | Node | undefined | <optional> | Text label to use for the expanded attributions button. Default is `»`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

#### olx.control.ControlOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `element` | Element | undefined | <optional> | The element is the control's container element. This only needs to be specified if you're developing a custom control.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `target` | Element | string | undefined | <optional> | Specify a target if you want the control to be rendered outside of the map's viewport.

#### olx.control.DefaultsOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `attribution` | boolean | undefined | <optional> | Attribution. Default is `true`.
  `attributionOptions` | olx.control.AttributionOptions | undefined | <optional> | Attribution options.
  `rotate` | boolean | undefined | <optional> | Rotate. Default is `true`.
  `rotateOptions` | olx.control.RotateOptions | undefined | <optional> | Rotate options.
  `zoom` | boolean | undefined | <optional> | Zoom. Default is `true`.
  `zoomOptions` | olx.control.ZoomOptions | undefined | <optional> | Zoom options.

#### olx.control.FullScreenOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS class name. Default is `ol-full-screen`.
  `label` | string | Node | undefined | <optional> | Text label to use for the button. Default is `\u2922` (NORTH EAST AND SOUTH WEST ARROW). Instead of text, also a Node (e.g. a `span` element) can be used.
  `labelActive` | string | Node | undefined | <optional> | Text label to use for the button when full-screen is active. Default is `\u00d7` (a cross). Instead of text, also a Node (e.g. a `span` element) can be used.
  `tipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Toggle full-screen`
  `keys` | boolean | undefined | <optional> | Full keyboard access.
  `target` | Element | undefined | <optional> | Target.
  `source` | Element | string | undefined | <optional> | The element to be displayed fullscreen. When not provided, the element containing the map viewport will be displayed fullscreen.

#### olx.control.MousePositionOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS class name. Default is `ol-mouse-position`.
  `coordinateFormat` | ol.CoordinateFormatType | undefined | <optional> | Coordinate format.
  `projection` | ol.ProjectionLike |  | Projection.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `target` | Element | undefined | <optional> | Target.
  `undefinedHTML` | string | undefined | <optional> | Markup for undefined coordinates. Default is `` (empty string).

#### olx.control.OverviewMapOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `collapsed` | boolean | undefined | <optional> | Whether the control should start collapsed or not (expanded). Default to `true`.
  `collapseLabel` | string | Node | undefined | <optional> | Text label to use for the expanded overviewmap button. Default is `«`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `collapsible` | boolean | undefined | <optional> | Whether the control can be collapsed or not. Default to `true`.
  `label` | string | Node | undefined | <optional> | Text label to use for the collapsed overviewmap button. Default is `»`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `layers` | Array.<ol.layer.Layer> | ol.Collection.<ol.layer.Layer> | undefined | <optional> | Layers for the overview map. If not set, then all main map layers are used instead.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `target` | Element | undefined | <optional> | Specify a target if you want the control to be rendered outside of the map's viewport.
  `tipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Overview map`
  `view` | ol.View | undefined | <optional> | Custom view for the overview map. If not provided, a default view with an EPSG:3857 projection will be used.

#### olx.control.RotateOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS class name. Default is `ol-rotate`.
  `label` | string | Element | undefined | <optional> | Text label to use for the rotate button. Default is `⇧`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `tipLabel` | string | undefined | <optional> | Text label to use for the rotate tip. Default is `Reset rotation`
  `duration` | number | undefined | <optional> | Animation duration in milliseconds. Default is `250`.
  `autoHide` | boolean | undefined | <optional> | Hide the control when rotation is 0. Default is `true`.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `resetNorth` | function | undefined | <optional> | Function called when the control is clicked. This will override the default resetNorth.
  `target` | Element | undefined | <optional> | Target.

#### olx.control.ScaleLineOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS Class name. Default is `ol-scale-line`.
  `minWidth` | number | undefined | <optional> | Minimum width in pixels. Default is `64`.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `target` | Element | undefined | <optional> | Target.
  `units` | ol.control.ScaleLineUnits | string | undefined | <optional> | Units. Default is `metric`.

#### olx.control.ZoomOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `duration` | number | undefined | <optional> | Animation duration in milliseconds. Default is `250`.
  `className` | string | undefined | <optional> | CSS class name. Default is `ol-zoom`.
  `zoomInLabel` | string | Node | undefined | <optional> | Text label to use for the zoom-in button. Default is `+`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `zoomOutLabel` | string | Node | undefined | <optional> | Text label to use for the zoom-out button. Default is `-`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `zoomInTipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Zoom in`
  `zoomOutTipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Zoom out`
  `delta` | number | undefined | <optional> | The zoom delta applied on each click.
  `target` | Element | undefined | <optional> | Target.

#### olx.control.ZoomSliderOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | CSS class name.
  `duration` | number | undefined | <optional> | Animation duration in milliseconds. Default is `200`.
  `maxResolution` | number | undefined | <optional> | Maximum resolution.
  `minResolution` | number | undefined | <optional> | Minimum resolution.
  `render` | function | undefined | <optional> | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

#### olx.control.ZoomToExtentOptions{Object}

  ##### Properties:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `className` | string | undefined | <optional> | Class name. Default is `ol-zoom-extent`.
  `target` | Element | undefined | <optional> | Target.
  `label` | string | Node | undefined | <optional> | Text label to use for the button. Default is `E`. Instead of text, also a Node (e.g. a `span` element) can be used.
  `tipLabel` | string | undefined | <optional> | Text label to use for the button tip. Default is `Zoom to extent`
  `extent` | ol.Extent | undefined | <optional> | The extent to zoom to. If undefined the validity extent of the view projection is used.