Class AlloyBasicLayer

an alloy basic layer uses the /api/layer/{code}/{x}/{y}/{z}/basic endpoint to request and display features. All features will be individual items.

Hierarchy

AlloyLayerWithFeaturesWithItemId<AlloyItemFeature>
- AlloyBasicLayer

Implements

Index

Constructors

constructor

Properties

Accessors

features

Methods

Constructors

constructor

new AlloyBasicLayer(options: AlloyBasicLayerOptions): AlloyBasicLayer

Overrides AlloyLayerWithFeaturesWithItemId.__constructor
- Defined in src/map/layers/basic/AlloyBasicLayer.ts:45
creates a new instance

Parameters
- options: AlloyBasicLayerOptions
  
  the options for the layer
Returns AlloyBasicLayer

Properties

bounds

bounds: Readonly<AlloyBounds>

implements

id

id: string

implements

layerCode

layerCode: string

the layer code for the cluster layer

map

implements

styles

styles: Readonly<AlloyLayerStyle[]>

implements

Accessors

features

get features(): Map<string, AlloyItemFeature>

Inherited from AlloyLayerWithFeatures.features
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:148
gets the features in the layer

Returns Map<string, AlloyItemFeature>

Methods

addFeature

addFeature(feature: AlloyItemFeature): boolean

Inherited from AlloyLayerWithFeaturesWithItemId.addFeature

Overrides AlloyLayerWithFeatures.addFeature
- Defined in src/map/layers/AlloyLayerWithFeaturesWithItemId.ts:38
override

Parameters
- feature: AlloyItemFeature
Returns boolean

addFeatures

addFeatures(features: AlloyItemFeature[]): boolean

Inherited from AlloyLayerWithFeaturesWithItemId.addFeatures

Overrides AlloyLayerWithFeatures.addFeatures
- Defined in src/map/layers/AlloyLayerWithFeaturesWithItemId.ts:60
override

Parameters
- features: AlloyItemFeature[]
Returns boolean

addFeaturesAddedListener

addFeaturesAddedListener(handler: FeaturesAddedEventHandler): void

Inherited from AlloyLayerWithFeatures.addFeaturesAddedListener
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:302
adds a handler to listen for the features added to layer

Parameters
- handler: FeaturesAddedEventHandler
  
  the handler to call when features have been added
Returns void

clearFeatures

clearFeatures(): boolean

Inherited from AlloyLayerWithFeaturesWithItemId.clearFeatures

Overrides AlloyLayerWithFeatures.clearFeatures
- Defined in src/map/layers/AlloyLayerWithFeaturesWithItemId.ts:73
override

Returns boolean

clone

clone(map: AlloyMap): AlloyBasicLayer

Implementation of AlloyStyledLayer.clone

Overrides AlloyLayerWithFeaturesWithItemId.clone
- Defined in src/map/layers/basic/AlloyBasicLayer.ts:91
implements

Parameters
- map: AlloyMap
Returns AlloyBasicLayer

dispose

dispose(): void

Overrides AlloyLayerWithFeatures.dispose
- Defined in src/map/layers/basic/AlloyBasicLayer.ts:83
implements

Returns void

findFeaturesWithin

findFeaturesWithin(source: AlloyCoordinate | AlloyFeature | Geometry, delta: number): FindFeaturesWithinResult[]

Inherited from AlloyLayerWithFeatures.findFeaturesWithin
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:281
finds features close to provided source

Parameters
- source: AlloyCoordinate | AlloyFeature | Geometry
  
  AlloyCoordinate, AlloyFeature or Geometry source to measure distance of features from
- delta: number
  
  distance (in metres) from source for which to return features
Returns FindFeaturesWithinResult[]

an array of results ordered by closest first

getFeatureById

getFeatureById(id: string): AlloyItemFeature | null

Implementation of AlloyStyledLayer.getFeatureById

Inherited from AlloyLayerWithFeatures.getFeatureById
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:141
implements

Parameters
- id: string
Returns AlloyItemFeature | null

getFeatureByItemId

getFeatureByItemId(itemId: string): AlloyItemFeature | null

Inherited from AlloyLayerWithFeaturesWithItemId.getFeatureByItemId
- Defined in src/map/layers/AlloyLayerWithFeaturesWithItemId.ts:82
gets a feature by it's item id property (if it has one)

Parameters
- itemId: string
Returns AlloyItemFeature | null

removeFeature

removeFeature(feature: AlloyItemFeature): boolean

Inherited from AlloyLayerWithFeaturesWithItemId.removeFeature

Overrides AlloyLayerWithFeatures.removeFeature
- Defined in src/map/layers/AlloyLayerWithFeaturesWithItemId.ts:49
override

Parameters
- feature: AlloyItemFeature
Returns boolean

removeFeaturesAddedListener

removeFeaturesAddedListener(handler: FeaturesAddedEventHandler): void

Inherited from AlloyLayerWithFeatures.removeFeaturesAddedListener
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:310
removes a handler listening to the features added to layer

Parameters
- handler: FeaturesAddedEventHandler
  
  the handler to stop listening
Returns void

resetStyle

resetStyle(feature: OLFeature): void

Inherited from AlloyLayerWithFeatures.resetStyle
- Defined in src/map/layers/AlloyLayerWithFeatures.ts:336
Temp function resets style for an ol feature

Parameters
- feature: OLFeature
  
  openlayers feature for which we want to reset style
Returns void

Generated using TypeDoc