Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layer

Represents a generic layer.

Hierarchy

Implements

Index

Constructors

constructor

  • new Layer(name: string): Layer
  • Initializes a Layer object.

    Parameters

    • name: string

    Returns Layer

Properties

layerSettings

layerSettings: LayerSettings = this.defaultLayerSettings()

The settings for this layer.

name

name: string

Methods

defaultLayerSettings

  • Returns the layer settings with the default settings applied.

    Returns LayerSettings

extraLayerParams

  • extraLayerParams(): string[]
  • Returns the additional custom parameters for this layer.

    Returns string[]

getBounds

getCopyrightString

  • getCopyrightString(): string
  • Returns the copyright string.

    Returns string

getDatasetHash

getExpiryTime

getLayerTemplateUrl

  • getLayerTemplateUrl(serverInfo: ServerInfo, authToken: string): when.Promise<string>
  • Returns the URL of the layer template.

    Parameters

    Returns when.Promise<string>

getQueryString

  • getQueryString(serverInfo: ServerInfo, authToken: string): string
  • Returns the template query string for this layer.

    Parameters

    Returns string

getTilePage

  • getTilePage(): string
  • Returns the server page for the map tile.

    Returns string

getType

  • getType(): string
  • Returns the type of the layer. This will be overridden with the type of the specific layer.

    Returns string

includeDatasetParams

  • includeDatasetParams(): boolean
  • Returns boolean

layerKey

  • layerKey(): string
  • Returns string

makeParam

  • makeParam(key: string, value: string): string
  • Parameters

    • key: string
    • value: string

    Returns string

prepareRequest

  • prepareRequest(): when.Promise<any>
  • Returns when.Promise<any>

shouldUseExtraParamsInCompositeLayer

  • shouldUseExtraParamsInCompositeLayer(): boolean
  • Returns boolean

tryCombine

  • tryCombine(lowerLayers: any[]): Layer
  • Attempts to combine this layer with other layers to form a composite layer.

    Parameters

    • lowerLayers: any[]

    Returns Layer

Generated using TypeDoc