Class: Popup

bemap.Popup(options)

Base class for popup.

Constructor

Parameters:
Name Type Description
options Object See below the available values.
Properties
Name Type Description
name String Name of popup.
properties Object custom object.
Source:

Members

(protected) closer_ :Object

Type:
  • Object
Source:

(protected) container_ :Object

Type:
  • Object
Source:

(protected) content_ :Object

Type:
  • Object
Source:

(protected) coordinate :bemap.Coordinate

Type:
Source:

(protected) id :String

Type:
  • String
Source:

(protected) information :String

Type:
  • String
Source:

(protected) map :Object

Type:
  • Object
Source:

(protected) name :String

Type:
  • String
Source:

(protected) native :Object

Type:
  • Object
Source:

(protected) properties :Object

Type:
  • Object
Source:

(protected) visible :Boolean

Type:
  • Boolean
Source:

Methods

addInformation(information) → {bemap.Popup}

Add the new content at the end of the current one.
Parameters:
Name Type Description
information String the new content to add.
Source:
Returns:
this;
Type
bemap.Popup

getCoordinate() → {bemap.Coordinate}

Return the position of the popup.
Source:
Returns:
this.coordinate;
Type
bemap.Coordinate

getId() → {String}

Return the id of the popup.
Source:
Returns:
this.id;
Type
String

getInformation() → {String}

Return the content of the popup.
Source:
Returns:
this.infomation;
Type
String

getName() → {String}

Return the name of the popup.
Source:
Returns:
this.name;
Type
String

hide() → {bemap.Popup}

Hide the popup.
Source:
Returns:
this.
Type
bemap.Popup

isVisible() → {Boolean}

Return the visibility of the popup.
Source:
Returns:
visible the visibility of the popup (true is visible and false is hidden).
Type
Boolean

remove() → {bemap.Popup}

Remove the popup from his map.
Source:
Returns:
this;
Type
bemap.Popup

setCoordinate(coordinate, options) → {bemap.Popup}

Set the position of the popup.
Parameters:
Name Type Description
coordinate bemap.Coordinate the new coordinate to set.
options object Options.
Properties
Name Type Description
panningMap bemap.Layer enable the map panning animation. move map from the current position to the popup anchor at the center of map.
Source:
Returns:
this;
Type
bemap.Popup

setId(id) → {bemap.Popup}

Return the id of the popup.
Parameters:
Name Type Description
id String the new id to set.
Source:
Returns:
this;
Type
bemap.Popup

setInformation(information) → {bemap.Popup}

Change the current content of the popup to a new one.
Parameters:
Name Type Description
information String the new content to set.
Source:
Returns:
this;
Type
bemap.Popup

setName(name) → {bemap.Popup}

Return the name of the popup.
Parameters:
Name Type Description
name String the new name to set.
Source:
Returns:
this;
Type
bemap.Popup

setVisible(Set) → {bemap.Popup}

Set the visibility of the popup.
Parameters:
Name Type Description
Set boolean to true to show the popup, otherwise false to hide it.
Source:
Returns:
this.
Type
bemap.Popup

show() → {bemap.Popup}

Show the popup.
Source:
Returns:
this.
Type
bemap.Popup