# Class: Openlayers

## vcs.vcm.maps.Openlayers

Openlayers Map Class (2D map)

#### new vcs.vcm.maps.Openlayers(options)

  Name | Type | Description
  --- | --- | ---
  `options` | vcs.vcm.maps.Openlayers.Options |

### Extends

- vcs.vcm.maps.Map

### Members

#### className{string}

  class Name of the Object

#### mapElement{HTMLElement}

#### movementDisabled{boolean}

  if true, no movements should occur

#### name{string}

  unique Name

### Methods

#### activate(viewPoint){Promise} inherited

  activates the map, if necessary initializes the map. this is a dummy method most likely to be overwritten by the specific map class.

  Name | Type | Description
  --- | --- | ---
  `viewPoint` | vcs.vcm.util.ViewPoint | the optional starting Viewpoint of the map after activation.

  ##### Fires:

  - `MAP_ACTIVATED` (vcs.vcm.maps) - vcs.vcm.event.EventType.MAP_ACTIVATED is triggered when a map is activated (and on each map switch).

#### activateMouseClickEvents(activate) inherited

  activates mouseClick Events on objects

  Name | Type | Description
  --- | --- | ---
  `activate` | boolean |

  Deprecated
    - 3.5

#### deactivate(){Promise} inherited

  deactivates the map returns the current viewpoint of the map to enable a change between different maps.

  ##### Returns:

  position returns the current viewpoint of the map.

#### dispose() inherited

  disposes the map

#### getActiveMouseClickEvents(){boolean} inherited

  returns whether mouse click events is activated or not

  Deprecated
    - 3.5

#### getClassName(){string} inherited

  returns the class name of this object.

  Deprecated
    - Yes

  ##### Returns:

  className

#### getConfigObject(){Object} inherited

#### getId(){string} inherited

  returns the id of this object

  Deprecated
    - Yes

#### getName(){string} inherited

  returns the name of the Object, the name is either given by the config Object or a uuid is generated

  Deprecated
    - Yes

#### getOl3Map(){ol.Map}

  returns the ol3 map object

#### getolMap(){ol.Map}

  returns the ol3 map object

  Deprecated
    - Yes

#### getViewPoint(opt_GroundPosition, opt_promise_flag){vcs.vcm.util.ViewPoint|Promise.<vcs.vcm.util.ViewPoint>}

  Name | Type | Description
  --- | --- | ---
  `GroundPosition` | boolean | whether to return the groundposition or not
  `promise_flag` | boolean |

#### gotoViewPoint(viewPoint)

  sets the view to the given viewpoint

  Name | Type | Description
  --- | --- | ---
  `viewPoint` | vcs.vcm.util.ViewPoint |

#### isActive(){boolean} inherited

  returns if this map is currently active

#### isInitialized(){boolean} inherited

  checks if the mapobject is already initialized

  Deprecated
    - 3.5

#### isSupported(){boolean} inherited

  checks if the current browser supports the MAP, also checks if all dependencies are there

  Deprecated
    - 3.5

#### pointIsVisible(coords){boolean}

  Name | Type | Description
  --- | --- | ---
  `coords` | ol.Coordinate | in WGS84 degrees

### Type Definitions

#### vcs.vcm.maps.Openlayers.Options{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `fixedNorthOrientation` | boolean | sets whether the openlayers map has a fixed orientation towards north (default true)