Class Layer

A Layer object used to configure a single Aeris Maps layer.

Hierarchy

Layer

Index

Constructors

constructor

Properties

code

Methods

Constructors

constructor

new Layer(code: string): Layer

- Defined in src/network/maps/Layer.ts:41
Initializes a layer instance with the specified AMP layer code.

memberof

Layer

Parameters
- code: string
Returns Layer

Properties

code

code: string

The layer code associated with the layer

memberof: Layer

Methods

addFilter

addFilter(filter: string): Layer

- Defined in src/network/maps/Layer.ts:202
Adds a filter to the layer.

memberof

Layer

Parameters
- filter: string
Returns Layer

alpha

alpha(value?: number): Layer

- Defined in src/network/maps/Layer.ts:93
The alpha (opacity) of the layer.

memberof

Layer

Parameters
- Optional value: number
Returns Layer

blendMode

blendMode(value?: string): Layer

- Defined in src/network/maps/Layer.ts:165
The blend mode to apply to the layer.

memberof

Layer

Parameters
- Optional value: string
Returns Layer

blur

blur(value?: number): Layer

- Defined in src/network/maps/Layer.ts:178
The amount to blur the layer, which is a value from 0 meaning no blur (default) to 10. The higher the value, the greater the blur effect.

memberof

Layer

Parameters
- Optional value: number
Returns Layer

darkStyle

darkStyle(value?: boolean): Layer

- Defined in src/network/maps/Layer.ts:105
A Boolean indicating whether the layer should use the dark style.

memberof

Layer

Parameters
- Optional value: boolean
Returns Layer

includeText

includeText(value?: boolean): Layer

- Defined in src/network/maps/Layer.ts:129
A Boolean indicating whether the layer should also include its associated text layer.

memberof

Layer

Parameters
- Optional value: boolean
Returns Layer

largeText

largeText(value?: boolean): Layer

- Defined in src/network/maps/Layer.ts:141
A Boolean indicating whether the text layer should use large text.

memberof

Layer

Parameters
- Optional value: boolean
Returns Layer

mask

mask(value?: string): Layer

- Defined in src/network/maps/Layer.ts:190
The mask layer to apply to the layer.

memberof

Layer

Parameters
- Optional value: string
Returns Layer

metric

metric(value?: boolean): Layer

- Defined in src/network/maps/Layer.ts:153
A Boolean indicating whether the layer should display text values in Metric units.

memberof

Layer

Parameters
- Optional value: boolean
Returns Layer

opt

opt(key: string, value?: any): Layer | any

- Defined in src/network/maps/Layer.ts:64
Sets or returns an option value.

memberof

Layer

Parameters
- key: string
- Optional value: any
Returns Layer | any

options

options(value?: LayerOptions): Layer | LayerOptions

- Defined in src/network/maps/Layer.ts:79
The layer configuration object.

memberof

Layer

Parameters
- Optional value: LayerOptions
Returns Layer | LayerOptions

removeAllFilters

removeAllFilters(): Layer

- Defined in src/network/maps/Layer.ts:228
Removes all filters from the layer.

memberof

Layer

Returns Layer

removeFilter

removeFilter(filter: string): Layer

- Defined in src/network/maps/Layer.ts:214
Removes a filter from the layer.

memberof

Layer

Parameters
- filter: string
Returns Layer

text

text(value?: boolean): Layer

- Defined in src/network/maps/Layer.ts:117
A Boolean indicating whether the layer is a text layer.

memberof

Layer

Parameters
- Optional value: boolean
Returns Layer

toString

toString(): string

- Defined in src/network/maps/Layer.ts:239
Returns the layer string based on the layer configuration.

memberof

Layer

Returns string

Generated using TypeDoc