Class Layer

A map layer defined by an ID and a name

Index

Methods

addEventListener disableInfoWindow filter fireEvent getDatasetId getDatasourceId getId getName isIssuedFromAPIData removeEventListner setVisible

Methods

addEventListener

addEventListener(event: string, listener: Function): void
Parameters
- event: string
- listener: Function
Returns void
Inherited from Listener.addEventListener
- Defined in listener.ts:15

disableInfoWindow

disableInfoWindow(): Promise<any>
Disable the infowindow on this layer. This method is useful if you want to implement your own infowindow outside of the map.

Returns Promise<any>
- Defined in layer.ts:88

filter

filter(where: string): Promise<any>
Filter the layer with a where clause. For example 'pop>2000'
Parameters
- where: string
  The where clause
Returns Promise<any>
- Defined in layer.ts:95

fireEvent

fireEvent(event: string, value?: any): void
Parameters
- event: string
- Optionalvalue: any
Returns void
Inherited from Listener.fireEvent
- Defined in listener.ts:30

getDatasetId

getDatasetId(): string
Returns string
the dataset ID used by this layer
- Defined in layer.ts:57

getDatasourceId

getDatasourceId(): string
The datasource ID can be: Datahub, CSV, Excel, Shape, GeoJSON, catalog, sql. A datasourceId=CE means the dataset is dynamically loaded by the API.

Returns string
the datasource ID of the layer.
- Defined in layer.ts:74

getId

getId(): string
Returns string
the unique ID of the layer
- Defined in layer.ts:41

getName

getName(): string
Returns string
the name of the layer
- Defined in layer.ts:49

isIssuedFromAPIData

isIssuedFromAPIData(): boolean
Returns boolean
true is the layer's dataset is provided directly through the API
- Defined in layer.ts:65

removeEventListner

removeEventListner(event: string, listener: Function): boolean
Parameters
- event: string
- listener: Function
Returns boolean
Inherited from Listener.removeEventListner
- Defined in listener.ts:24

setVisible

setVisible(visible: boolean): Promise<any>
Parameters
- visible: boolean
  true to set visible, false to hide the layer
Returns Promise<any>
- Defined in layer.ts:81