# Class: Popup

## bemap.Popup(options)

Base class for popup.

## Constructor

#### new Popup(options)

##### 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:
  - bemap-model/bemap-popup.js, line 14

### Members

#### (protected) closer_ :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 33

#### (protected) container_ :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 27

#### (protected) content_ :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 39

#### (protected) coordinate :bemap.Coordinate

##### Type:

- bemap.Coordinate

Source:
  - bemap-model/bemap-popup.js, line 63

#### (protected) id :String

##### Type:

- String

Source:
  - bemap-model/bemap-popup.js, line 69

#### (protected) information :String

##### Type:

- String

Source:
  - bemap-model/bemap-popup.js, line 45

#### (protected) map :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 57

#### (protected) name :String

##### Type:

- String

Source:
  - bemap-model/bemap-popup.js, line 75

#### (protected) native :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 21

#### (protected) properties :Object

##### Type:

- Object

Source:
  - bemap-model/bemap-popup.js, line 81

#### (protected) visible :Boolean

##### Type:

- Boolean

Source:
  - bemap-model/bemap-popup.js, line 51

### 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:
  - bemap-model/bemap-popup.js, line 202

##### Returns:

this;

Type
  bemap.Popup

#### getCoordinate() → {bemap.Coordinate}

Return the position of the popup.

Source:
  - bemap-model/bemap-popup.js, line 96

##### Returns:

this.coordinate;

Type
  bemap.Coordinate

#### getId() → {String}

Return the id of the popup.

Source:
  - bemap-model/bemap-popup.js, line 104

##### Returns:

this.id;

Type
  String

#### getInformation() → {String}

Return the content of the popup.

Source:
  - bemap-model/bemap-popup.js, line 88

##### Returns:

this.infomation;

Type
  String

#### getName() → {String}

Return the name of the popup.

Source:
  - bemap-model/bemap-popup.js, line 112

##### Returns:

this.name;

Type
  String

#### hide() → {bemap.Popup}

Hide the popup.

Source:
  - bemap-model/bemap-popup.js, line 138

##### Returns:

this.

Type
  bemap.Popup

#### isVisible() → {Boolean}

Return the visibility of the popup.

Source:
  - bemap-model/bemap-popup.js, line 120

##### 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:
  - bemap-model/bemap-popup.js, line 214

##### 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:
  - bemap-model/bemap-popup.js, line 192

##### 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:
  - bemap-model/bemap-popup.js, line 170

##### 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:
  - bemap-model/bemap-popup.js, line 157

##### 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:
  - bemap-model/bemap-popup.js, line 180

##### 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:
  - bemap-model/bemap-popup.js, line 129

##### Returns:

this.

Type
  bemap.Popup

#### show() → {bemap.Popup}

Show the popup.

Source:
  - bemap-model/bemap-popup.js, line 147

##### Returns:

this.

Type
  bemap.Popup