Class FlatMapStylingLayer

Index

Constructors

Accessors

active centre description extent id layer minimapStylingLayers minZoom parentLayer

Methods

activate addLayeredMarker clearVisibilityFilter dimRasterLayers setFlatPathMode setPaint setParent setVisibilityFilter updateBaseMarker

Constructors

constructor

new FlatMapStylingLayer(
    flatmap: FlatMap,
    ui: UserInteractions,
    layer: FlatMapLayer,
    options: StylingOptions,
): FlatMapStylingLayer
Parameters
- flatmap: FlatMap
- ui: UserInteractions
- layer: FlatMapLayer
- options: StylingOptions
Returns FlatMapStylingLayer
- Defined in src/layers/index.ts:82

Accessors

active

get active(): boolean
Returns boolean
- Defined in src/layers/index.ts:184

centre

get centre(): [number, number]
Returns [number, number]
- Defined in src/layers/index.ts:190

description

get description(): string
Returns string
- Defined in src/layers/index.ts:197

extent

get extent(): MapExtent
Returns MapExtent
- Defined in src/layers/index.ts:203

id

get id(): string
Returns string
- Defined in src/layers/index.ts:209

layer

get layer(): FlatMapLayer
Returns FlatMapLayer
- Defined in src/layers/index.ts:215

minimapStylingLayers

get minimapStylingLayers(): LayerSpecification[]
Returns LayerSpecification[]
- Defined in src/layers/index.ts:221

minZoom

get minZoom(): number
Returns number
- Defined in src/layers/index.ts:227

parentLayer

get parentLayer(): FlatMapStylingLayer
Returns FlatMapStylingLayer
- Defined in src/layers/index.ts:233

Methods

activate

activate(enable?: boolean): void
Parameters
- enable: boolean = true
Returns void
- Defined in src/layers/index.ts:245

addLayeredMarker

addLayeredMarker(
    annotation: FlatMapFeatureAnnotation,
    options: FlatMapMarkerOptions,
    cluster?: boolean,
): number
Parameters
- annotation: FlatMapFeatureAnnotation
- options: FlatMapMarkerOptions
- cluster: boolean = false
Returns number
- Defined in src/layers/index.ts:264

clearVisibilityFilter

clearVisibilityFilter(): void
Returns void
- Defined in src/layers/index.ts:340

dimRasterLayers

dimRasterLayers(dimmed?: boolean): void
Parameters
- dimmed: boolean = true
Returns void
- Defined in src/layers/index.ts:407

setFlatPathMode

setFlatPathMode(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in src/layers/index.ts:348

setPaint

setPaint(options: StylingOptions): void
Parameters
- options: StylingOptions
Returns void
- Defined in src/layers/index.ts:356

setParent

setParent(parentLayer: FlatMapStylingLayer): void
Parameters
- parentLayer: FlatMapStylingLayer
Returns void
- Defined in src/layers/index.ts:239

setVisibilityFilter

setVisibilityFilter(filter: StyleFilterType): void
Parameters
- filter: StyleFilterType
Returns void
- Defined in src/layers/index.ts:380

updateBaseMarker

updateBaseMarker(
baseFeature: FlatMapFeatureAnnotation,
options: FlatMapMarkerOptions,
): void
Parameters
- baseFeature: FlatMapFeatureAnnotation
- options: FlatMapMarkerOptions
Returns void
- Defined in src/layers/index.ts:274