Class Layer

A map layer defined by an ID and a name

Hierarchy

  • Listener
    • Layer

Methods

addEventListener disableInfoWindow filter fireEvent getDatasetId getDatasourceId getId getName isIssuedFromAPIData removeEventListner setVisible

Methods

addEventListener

  • addEventListener(event, listener): void

  • Parameters

    • event: string
    • listener: Function

    Returns void

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>

filter

  • filter(where): Promise<any>

  • Filter the layer with a where clause. For example 'pop>2000'

    Parameters

    • where: string

      The where clause

    Returns Promise<any>

fireEvent

  • fireEvent(event, value?): void

  • Parameters

    • event: string
    • Optionalvalue: any

    Returns void

getDatasetId

  • getDatasetId(): String

  • Returns String

    the dataset ID used by this layer

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.

getId

  • getId(): String

  • Returns String

    the unique ID of the layer

getName

  • getName(): String

  • Returns String

    the name of the layer

isIssuedFromAPIData

  • isIssuedFromAPIData(): boolean

  • Returns boolean

    true is the layer's dataset is provided directly through the API

removeEventListner

  • removeEventListner(event, listener): boolean

  • Parameters

    • event: string
    • listener: Function

    Returns boolean

setVisible

  • setVisible(visible): Promise<any>

  • Parameters

    • visible: boolean

      true to set visible, false to hide the layer

    Returns Promise<any>

Settings

On This Page

addEventListenerdisableInfoWindowfilterfireEventgetDatasetIdgetDatasourceIdgetIdgetNameisIssuedFromAPIDataremoveEventListnersetVisible