Class Controller

API for controlling data and layers

Hierarchy

Controller

Constructors

constructor

new Controller(options: ControllerOptions): Controller
Interface to control layers, reference system, axis and overlay. overlay is created on instantiation, does not currently support opt-out.

Example
```
scaleOptions = { xMin: 0, xMax: 100, yMin: 0, yMax: 100 }
```
Example
```
scaleOptions = { xBounds: [0 , 100], yBounds: [0, 100] }
```
Parameters
- options: ControllerOptions
Returns Controller
- Defined in control/MainController.ts:32

Properties

`Private` _overlay

_overlay: Overlay<Controller>

`Private` _referenceSystem

_referenceSystem: IntersectionReferenceSystem

`Private` layerManager

layerManager: LayerManager

Accessors

axis

get axis(): Axis
Returns Axis
- Defined in control/MainController.ts:289

currentStateAsEvent

get currentStateAsEvent(): OnRescaleEvent
Returns OnRescaleEvent
- Defined in control/MainController.ts:293

overlay

get overlay(): Overlay<Controller>
Returns Overlay<Controller>
- Defined in control/MainController.ts:277

referenceSystem

get referenceSystem(): IntersectionReferenceSystem
Returns IntersectionReferenceSystem
- Defined in control/MainController.ts:281

zoomPanHandler

get zoomPanHandler(): ZoomPanHandler
Returns ZoomPanHandler
- Defined in control/MainController.ts:285

Methods

addLayer

addLayer(layer: Layer<unknown>, params?: LayerOptions<unknown>): Controller
Adds layer to list, and initializes it
Parameters
- layer: Layer<unknown>
  
  layer object
- Optional params: LayerOptions<unknown>
  
  (optional) adds additional parameters to the onUpdateEvent
Returns Controller
- Defined in control/MainController.ts:82

adjustToSize

adjustToSize(width: number, height: number): Controller
Adjust layers, axis, overlay, and zoom according to inputted dimensions
Parameters
- width: number
  
  (required)
- height: number
  
  (required)
Returns Controller
- Defined in control/MainController.ts:136

clearAllData

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

destroy

destroy(): Controller
Destroy Controller Convenience method for removing from DOM and clearing references

Returns Controller
- Defined in control/MainController.ts:258

`Private` getHighestZIndex

getHighestZIndex(layers: Layer<unknown>[]): number
Parameters
- layers: Layer<unknown>[]
Returns number
- Defined in control/MainController.ts:267

getLayer

getLayer(layerId: string): Layer<unknown>
Find first layer with given id, returns undefined if none are found
Parameters
- layerId: string
  
  string id
Returns Layer<unknown>
- Defined in control/MainController.ts:109

hideAxis

hideAxis(): Controller
Hide both axes

Returns Controller
- Defined in control/MainController.ts:178

hideAxisLabels

hideAxisLabels(): Controller
Hide labels in x and y

Returns Controller
- Defined in control/MainController.ts:194

hideLayer

hideLayer(layerId: string): Controller
Sets visibility to false
Parameters
- layerId: string
  
  string id
Returns Controller
- Defined in control/MainController.ts:126

removeAllLayers

removeAllLayers(): Controller
Remove and unmount all layers from list

Returns Controller
- Defined in control/MainController.ts:100

removeLayer

removeLayer(layerId: string): Controller
Remove and unmount layer from list
Parameters
- layerId: string
  
  string id
Returns Controller
- Defined in control/MainController.ts:92

setAxisOffset

setAxisOffset(x: number, y: number): Controller
Sets domain offset, offset is subtracted from domain
Parameters
- x: number
- y: number
Returns Controller
- Defined in control/MainController.ts:204

setBounds

setBounds(xBounds: [number, number], yBounds: [number, number]): Controller
Sets bounds for zoom and pan handler
Parameters
- xBounds: [number, number]
  
  domain in x-direction
- yBounds: [number, number]
  
  domain in y-direction
Returns Controller
- Defined in control/MainController.ts:162

setMaxZoomLevel

setMaxZoomLevel(zoomlevel: number): Controller
Defines how far in one can zoom
Parameters
- zoomlevel: number
Returns Controller
- Defined in control/MainController.ts:240

setMinZoomLevel

setMinZoomLevel(zoomlevel: number): Controller
Defines how far out one can zoom
Parameters
- zoomlevel: number
Returns Controller
- Defined in control/MainController.ts:249

`Private` setOverlayZIndex

setOverlayZIndex(layers: Layer<unknown>[]): void
Parameters
- layers: Layer<unknown>[]
Returns void
- Defined in control/MainController.ts:272

setReferenceSystem

setReferenceSystem(referenceSystem: IntersectionReferenceSystem): Controller
Sets reference system, overrides any existing reference systems in place
Parameters
- referenceSystem: IntersectionReferenceSystem
  
  IntersectionReferenceSystem
Returns Controller
- Defined in control/MainController.ts:50

setViewport

setViewport(cx?: number, cy?: number, displacement?: number, duration?: number): Controller
Set new viewport
Parameters
- Optional cx: number
  
  center X pos
- Optional cy: number
  
  center Y pos
- Optional displacement: number
- Optional duration: number
  
  duration of transition
Returns Controller
- Defined in control/MainController.ts:152

setXAxisOffset

setXAxisOffset(x: number): Controller
Sets domain offset in x-direction, offset is subtracted from domain
Parameters
- x: number
Returns Controller
- Defined in control/MainController.ts:213

setYAxisOffset

setYAxisOffset(y: number): Controller
Sets domain offset in y-direction, offset is subtracted from domain
Parameters
- y: number
Returns Controller
- Defined in control/MainController.ts:222

setZoomLevelBoundary

setZoomLevelBoundary(zoomlevels: [number, number]): Controller
Defines min and max of how much one can zoom
Parameters
- zoomlevels: [number, number]
Returns Controller
- Defined in control/MainController.ts:231

showAxis

showAxis(): Controller
Display both axes

Returns Controller
- Defined in control/MainController.ts:170

showAxisLabels

showAxisLabels(): Controller
Shows labels in x and y

Returns Controller
- Defined in control/MainController.ts:186

showLayer

showLayer(layerId: string): Controller
Sets visibility to true and rescales the layer
Parameters
- layerId: string
  
  string id
Returns Controller
- Defined in control/MainController.ts:117

updatePath

updatePath(path: number[][], options?: ReferenceSystemOptions): Controller
Creates new reference system based on path, overrides any existing reference systems in place
Parameters
- path: number[][]
  
  array of coords
- Optional options: ReferenceSystemOptions
  
  optional
Returns Controller
- Defined in control/MainController.ts:62

Generated using TypeDoc