Home Reference Source 
import {FeaturePopup} from 'guide4you/src/FeaturePopup.js'
public class | source

FeaturePopup

Expression Extends:

class FeaturePopup extends mixin(BaseObject, ListenerOrganizerMixin)

Displays a Popup bound to a geographical position via an ol.Overlay

Static Method Summary

Static Public Methods
public static

canDisplay(feature: ol.Feature): boolean

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
Private Members
private

$description_: jQuery

private

$element_: jQuery

private

$name_: jQuery

private
private
private
private
private
private
private
private
private
private

feature_: null | ol.Feature

private
private
private

overlay_: ol.Overlay

private
private

referencingVisibleLayers_: VectorLayer[]

private
private

Method Summary

Public Methods
public

addIconSizedOffset(feature: ol.Feature, style: ol.style.Style, resolution: number)

calculates iconSized Offset and applies it
public
public

centerMapOnPopup(animated: *)

Centers the map on the popup after all images have been loaded
public

getCenter(): ol.Coordinate

calculates Center of the Popup.
public

getFeature(): null | ol.Feature

public

getLayers(): Array | VectorLayer[]

public
public
public

layerContainsFeature(layer: *, feature: *): boolean

public

setFeature(feature: ol.Feature, layer: ol.layer.Base, style: ol.style.Style, clickCoordinate: ol.Coordinate, optPopupModifiers: string[])

The feature should have a property 'name' and/or 'description' to be shown inside of the popup.
public

setMap(map: G4UMap)

public

setVisible(visible: boolean)

public

update(style: *)

Update the Popup.
public
public
Private Methods
private

onFeatureClick_(feature: ol.Feature, layer: ol.layer.Vector, coordinate: ol.Coordinate)

private

removeReferencingLayer_(layer: VectorLayer)

Static Public Methods

public static canDisplay(feature: ol.Feature): boolean source

Params:

NameTypeAttributeDescription
feature ol.Feature

Return:

boolean

Public Constructors

public constructor(options: FeaturePopupOptions) source

Params:

NameTypeAttributeDescription
options FeaturePopupOptions

Public Members

public geometryChangeHandler_: * source

Private Members

private $description_: jQuery source

private $element_: jQuery source

private $name_: jQuery source

private animated_: boolean source

private centerOnPopupInitial_: boolean source

private centerOnPopup_: boolean source

private classNameFeatureDescription_: string source

private classNameFeatureName_: string source

private className_: string source

private currentPopupModifiers_: string[] source

private defaultPopupModifiers_: string[] source

private draggable_: boolean source

private feature_: null | ol.Feature source

private iconSizedOffset_: number[] source

private map__: G4UMap source

private overlay_: ol.Overlay source

private pixelOffset_: number[] source

private referencingVisibleLayers_: VectorLayer[] source

private visible_: boolean source

private window_: Window source

Public Methods

public addIconSizedOffset(feature: ol.Feature, style: ol.style.Style, resolution: number) source

calculates iconSized Offset and applies it

Params:

NameTypeAttributeDescription
feature ol.Feature
style ol.style.Style
resolution number

public addReferencingLayer_(layer: *) source

Params:

NameTypeAttributeDescription
layer *

public centerMapOnPopup(animated: *) source

Centers the map on the popup after all images have been loaded

Params:

NameTypeAttributeDescription
animated *

public getCenter(): ol.Coordinate source

calculates Center of the Popup. Be careful, this calculation repositions the popup to calculate the center properly and repostions to the initial Position again. This does only work if the popup is already visible!

Return:

ol.Coordinate

public getFeature(): null | ol.Feature source

Return:

null | ol.Feature

public getLayers(): Array | VectorLayer[] source

Return:

Array | VectorLayer[]

public getMap(): G4UMap source

Return:

G4UMap

public getVisible(): boolean source

Return:

boolean

public layerContainsFeature(layer: *, feature: *): boolean source

Params:

NameTypeAttributeDescription
layer *
feature *

Return:

boolean

public setFeature(feature: ol.Feature, layer: ol.layer.Base, style: ol.style.Style, clickCoordinate: ol.Coordinate, optPopupModifiers: string[]) source

The feature should have a property 'name' and/or 'description' to be shown inside of the popup.

Params:

NameTypeAttributeDescription
feature ol.Feature
layer ol.layer.Base
style ol.style.Style
clickCoordinate ol.Coordinate
optPopupModifiers string[]
  • optional
  • default: []

public setMap(map: G4UMap) source

Params:

NameTypeAttributeDescription
map G4UMap

public setVisible(visible: boolean) source

Params:

NameTypeAttributeDescription
visible boolean

public update(style: *) source

Update the Popup. Call this if something in the feature has changed

Params:

NameTypeAttributeDescription
style *

public updateContent(): * source

Return:

*

public updateSize() source

Private Methods

private onFeatureClick_(feature: ol.Feature, layer: ol.layer.Vector, coordinate: ol.Coordinate) source

Params:

NameTypeAttributeDescription
feature ol.Feature
layer ol.layer.Vector
coordinate ol.Coordinate

private removeReferencingLayer_(layer: VectorLayer) source

Params:

NameTypeAttributeDescription
layer VectorLayer