Class AlloyCableLayer

an alloy cable layer for rendering cable and feeds features provided externally on the map, use this to add cable features onto the map and animate them automatically

Hierarchy

AlloyAnimatedPathLayer
- AlloyCableLayer

Implements

AlloyLayer

Index

Constructors

constructor

Properties

id
map

Methods

Constructors

constructor

new AlloyCableLayer(options: AlloyCableLayerOptions): AlloyCableLayer

Overrides AlloyAnimatedPathLayer.constructor
- Defined in src/map/layers/cable/AlloyCableLayer.ts:45
creates a new instance

Parameters
- options: AlloyCableLayerOptions
  
  the options for the layer
Returns AlloyCableLayer

Properties

id

id: string

implements

map

implements

Methods

clear

clear(): void

- Defined in src/map/layers/cable/AlloyCableLayer.ts:145
Clears the layer and stops cable animation

Returns void

clone

clone(map: AlloyMap): AlloyCableLayer

Implementation of AlloyLayer.clone

Overrides AlloyAnimatedPathLayer.clone
- Defined in src/map/layers/cable/AlloyCableLayer.ts:180
implements

Parameters
- map: AlloyMap
Returns AlloyCableLayer

dispose

dispose(): void

Inherited from AlloyAnimatedPathLayer.dispose
- Defined in src/map/layers/animation/AlloyAnimatedPathLayer.ts:205
implements

Returns void

getFeatureById

getFeatureById(id: string): AlloyFeature | null

Implementation of AlloyLayer.getFeatureById

Overrides AlloyAnimatedPathLayer.getFeatureById
- Defined in src/map/layers/cable/AlloyCableLayer.ts:164
implements

Parameters
- id: string
Returns AlloyFeature | null

setCableFeature

setCableFeature(cable: AlloyCableFeature): void

- Defined in src/map/layers/cable/AlloyCableLayer.ts:61
Sets cable feature and starts animation

Parameters
- cable: AlloyCableFeature
  
  cable feature
Returns void

setConnectedUnits

setConnectedUnits(units: AlloyCableUnitFeature[]): void

- Defined in src/map/layers/cable/AlloyCableLayer.ts:124
Sets connected unit features for cable

Parameters
- units: AlloyCableUnitFeature[]
  
  array of connected unit features
Returns void

setMainFeed

setMainFeed(feed: AlloyCableUnitFeature | null): void

- Defined in src/map/layers/cable/AlloyCableLayer.ts:82
Sets main feed feature for cable

Parameters
- feed: AlloyCableUnitFeature | null
  
  main feed feature
Returns void

setSubFeed

setSubFeed(feed: AlloyCableUnitFeature | null): void

- Defined in src/map/layers/cable/AlloyCableLayer.ts:103
Sets sub feed feature for cable

Parameters
- feed: AlloyCableUnitFeature | null
  
  sub feed feature
Returns void

Generated using TypeDoc