Class: PerspectiveMap

ol. PerspectiveMap

A map with a perspective


new PerspectiveMap( [options], tiltCondition)

Parameters:
Name Type Argument Description
options olx.MapOptions <optional>
tiltCondition ol.events.condition

, default altKeyOnly

Fires:
  • change:perspective

Extends

Methods


addFilter(filter)

Add a filter to an ol.Map

Parameters:
Name Type Description
filter ol.filter
Inherited From:
Overrides:

animateFeature(feature, fanim)

Animate feature on a map

Parameters:
Name Type Description
feature ol.Feature

Feature to animate

fanim ol.featureAnimation | Array.<ol.featureAnimation>

the animation to play

Inherited From:
Overrides:
Returns:

an object to control animation with start, stop and isPlaying function

Type
animationControler

animExtent(point, options)

Pulse an extent on postcompose

Parameters:
Name Type Description
point ol.coordinates

to pulse

options ol.pulse.options

pulse options param

Properties
Name Type Description
projection ol.projectionLike | undefined

projection of coords, default no transform

duration Number

animation duration in ms, default 2000

easing ol.easing

easing function, default ol.easing.upAndDown

style ol.style.Stroke

stroke style, default 2px red

Inherited From:
Overrides:

getFilters()

Get filters associated with an ol.Map

Inherited From:
Overrides:
Returns:
Type
Array.<ol.filter>

getMatrix3D()

Get map full teansform matrix3D

Returns:
Type
Array.<Array.<number>>

getPixelFromPixelScreen()

Not working...


getPixelRatio()

Get pixel ratio for the map


getPixelScreenFromCoordinate(coord)

Get pixel at screen from coordinate. The default getPixelFromCoordinate get pixel in the perspective.

Parameters:
Name Type Description
coord ol.coordinate
ol.pixel

handleMapBrowserEvent(mapBrowserEvent)

Convert to pixel coord according to the perspective

Parameters:
Name Type Description
mapBrowserEvent MapBrowserEvent

The event to handle.


hideTarget()

Hide the target overlay

Inherited From:
Overrides:

markup(point, pulse)

Show a markup a point on postcompose

Parameters:
Name Type Description
point ol.coordinates

to pulse

pulse ol.markup.options

options param - projection {ol.projection|String|undefined} projection of coords, default none - delay {Number} delay before mark fadeout - maxZoom {Number} zoom when mark fadeout - style {ol.style.Image|ol.style.Style|Array<ol.style.Style>} Image to draw as markup, default red circle

Inherited From:
Overrides:
Deprecated:
  • use map.animateFeature instead
Returns:

Unique key for the listener with a stop function to stop animation


pulse(point, pulse)

Pulse a point on postcompose

Parameters:
Name Type Description
point ol.coordinates

to pulse

pulse ol.pulse.options

options param - projection {ol.projection||String} projection of coords - duration {Number} animation duration in ms, default 3000 - amplitude {Number} movement amplitude 0: none - 0.5: start at 0.5*radius of the image - 1: max, default 1 - easing {ol.easing} easing function, default ol.easing.easeOut - style {ol.style.Image|ol.style.Style|Array<ol.style.Style>} Image to draw as markup, default red circle

Inherited From:
Overrides:
Deprecated:
  • use map.animateFeature instead

removeFilter(filter)

Remove a filter to an ol.Map

Parameters:
Name Type Description
filter ol.filter
Inherited From:
Overrides:

setPerspective(angle, options)

Set perspective angle

Parameters:
Name Type Description
angle number

the perspective angle 0 (vertical) - 30 (max), default 0

options *
Properties
Name Type Description
duration number

The duration of the animation in milliseconds, default 500

easing function

The easing function used during the animation, defaults to ol.easing.inAndOut).


showTarget(coord)

Show a target overlay at coord

Parameters:
Name Type Description
coord ol.coordinate
Inherited From:
Overrides: