Class LayerManager

Hierarchy

LayerManager

Constructors

constructor

new LayerManager(container: HTMLElement, scaleOptions?: ScaleOptions, axisOptions?: AxisOptions): LayerManager
Handles layers and axis also holds a zoom and pan handler object
Parameters
- container: HTMLElement
  
  root container
- Optional scaleOptions: ScaleOptions
- Optional axisOptions: AxisOptions
Returns LayerManager
- Defined in control/LayerManager.ts:28

Properties

`Private` _axis

_axis: Axis

`Private` _svgContainer

_svgContainer: Selection<HTMLElement, unknown, null, undefined>

`Private` _zoomPanHandler

_zoomPanHandler: ZoomPanHandler

`Private` container

container: HTMLElement

`Private` layerContainer

layerContainer: HTMLElement

`Private` layers

layers: Layer<unknown>[] = []

Accessors

axis

get axis(): Axis
Returns Axis
- Defined in control/LayerManager.ts:264

zoomPanHandler

get zoomPanHandler(): ZoomPanHandler
Returns ZoomPanHandler
- Defined in control/LayerManager.ts:260

Methods

addLayer

addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager
Adds the layer to the manager, and mounts it
Parameters
- layer: Layer<unknown>
  
  Layer
- Optional params: LayerOptions<unknown>
  
  extra params to pass to the onUpdate method
Returns LayerManager
- Defined in control/LayerManager.ts:84

addLayers

addLayers(layers: Layer<unknown>[]): LayerManager
Adds and mounts an array of layers
Parameters
- layers: Layer<unknown>[]
  
  array of layers
Returns LayerManager
- Defined in control/LayerManager.ts:58

adjustToSize

adjustToSize(width: number, height: number): void
Adjust layers, axis, and zoom according to inputted dimensions
Parameters
- width: number
  
  (required)
- height: number
  
  (required)
Returns void
- Defined in control/LayerManager.ts:162

clearAllData

clearAllData(includeReferenceSystem?: boolean): LayerManager
Clears data from all mounted layers
Parameters
- includeReferenceSystem: boolean = true
  
  (optional) if true also removes reference system, default is true
Returns LayerManager
- Defined in control/LayerManager.ts:74

`Private` createAxis

createAxis(options: AxisOptions): Axis
Parameters
- options: AxisOptions
Returns Axis
- Defined in control/LayerManager.ts:277

destroy

destroy(): LayerManager
Returns LayerManager
- Defined in control/LayerManager.ts:247

getLayer

getLayer(layerId: string): Layer<unknown>
Parameters
- layerId: string
Returns Layer<unknown>
- Defined in control/LayerManager.ts:116

getLayers

getLayers(): Layer<unknown>[]
Gets all layers currently mounted

Returns Layer<unknown>[]
- Defined in control/LayerManager.ts:66

hideAxis

hideAxis(): LayerManager
Returns LayerManager
- Defined in control/LayerManager.ts:188

hideAxisLabels

hideAxisLabels(): LayerManager
Returns LayerManager
- Defined in control/LayerManager.ts:198

hideLayer

hideLayer(layerId: string): LayerManager
Parameters
- layerId: string
Returns LayerManager
- Defined in control/LayerManager.ts:147

initLayer

initLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): LayerManager
Parameters
- layer: Layer<unknown>
- Optional params: LayerOptions<unknown>
Returns LayerManager
- Defined in control/LayerManager.ts:120

removeAllLayers

removeAllLayers(): LayerManager
Remove and unmount all layers from manager

Returns LayerManager
- Defined in control/LayerManager.ts:108

removeLayer

removeLayer(layerId: string): LayerManager
Remove and unmount layer from manager
Parameters
- layerId: string
  
  name of layer
Returns LayerManager
- Defined in control/LayerManager.ts:95

`Private` rescale

rescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
- Defined in control/LayerManager.ts:268

setAxisOffset

setAxisOffset(x: number, y: number): LayerManager
Parameters
- x: number
- y: number
Returns LayerManager
- Defined in control/LayerManager.ts:203

setMaxZoomLevel

setMaxZoomLevel(zoomlevel: number): LayerManager
Parameters
- zoomlevel: number
Returns LayerManager
- Defined in control/LayerManager.ts:237

setMinZoomLevel

setMinZoomLevel(zoomlevel: number): LayerManager
Parameters
- zoomlevel: number
Returns LayerManager
- Defined in control/LayerManager.ts:242

setReferenceSystem

setReferenceSystem(irs: IntersectionReferenceSystem): void
Parameters
- irs: IntersectionReferenceSystem
Returns void
- Defined in control/LayerManager.ts:179

setXAxisOffset

setXAxisOffset(x: number): LayerManager
Parameters
- x: number
Returns LayerManager
- Defined in control/LayerManager.ts:214

setYAxisOffset

setYAxisOffset(y: number): LayerManager
Parameters
- y: number
Returns LayerManager
- Defined in control/LayerManager.ts:223

setZoomLevelBoundary

setZoomLevelBoundary(zoomlevels: [number, number]): LayerManager
Parameters
- zoomlevels: [number, number]
Returns LayerManager
- Defined in control/LayerManager.ts:232

showAxis

showAxis(): LayerManager
Returns LayerManager
- Defined in control/LayerManager.ts:183

showAxisLabels

showAxisLabels(): LayerManager
Returns LayerManager
- Defined in control/LayerManager.ts:193

showLayer

showLayer(layerId: string): LayerManager
Parameters
- layerId: string
Returns LayerManager
- Defined in control/LayerManager.ts:137

Generated using TypeDoc