Class LogController

A container component for tracks, with track titles, legends, adding/removing tracks, resizing and user interaction.

Hierarchy (view full)

LogController
- LogViewer

Constructors

constructor

new LogController(options?): LogController
Parameters
- options: LogControllerOptions = {}
Returns LogController
- Defined in ui/log-controller.ts:65

Properties

`Private` _deferredUpdate

_deferredUpdate: any = null

`Protected` _initialized

_initialized: boolean

`Protected` _legendHeight

_legendHeight: number

`Private` _observer

_observer: ResizeObserver

`Private` _scaleHandler

_scaleHandler: ScaleHandler

`Protected` _titleFontSize

_titleFontSize: number

`Protected` _titleHeight

_titleHeight: number

`Protected` _trackHeight

_trackHeight: number

`Protected` _uiScale

_uiScale: number

container

container: any

debounce

debounce: DebounceFunction

height

height: number

legendRows

legendRows: number

legends

legends: {
[propName: string]: LegendMap;
}

Type declaration

[propName: string]: LegendMap

options

options: LogControllerOptions

tracks

tracks: Track<TrackOptions>[]

width

width: number

zoom

zoom: ZoomBehavior<Element, any>

Accessors

domain

get domain(): Domain
Getter for (base) domain

Returns Domain
- Defined in ui/log-controller.ts:742
set domain(value): void
Setter for (base) domain
Parameters
- value: Domain
Returns void
- Defined in ui/log-controller.ts:750

innerBounds

get innerBounds(): {
length: number;
span: number;
}
Get the track container's dimmensions, relative to orientation.

Returns {
length: number;
span: number;
}
- length: number
- span: number
- Defined in ui/log-controller.ts:733

scale

get scale(): Scale
Getter for the component's internal scale

Returns Scale
- Defined in ui/log-controller.ts:777

scaleHandler

get scaleHandler(): ScaleHandler
Getter for scaleHandler

Returns ScaleHandler
current scale handler
- Defined in ui/log-controller.ts:761
set scaleHandler(newHandler): void
Setter for scaleHandler
Parameters
- newHandler: ScaleHandler
  new scale handler
Returns void
- Defined in ui/log-controller.ts:769

zoomHandler

get zoomHandler(): any
DOM element that has the zoom behaviour attached

Returns any
- Defined in ui/log-controller.ts:725

Methods

`Private` _trackEnter

_trackEnter(selection): void
Add DOM-elements for new tracks
Parameters
- selection: any
  enter selection
Returns void
- Defined in ui/log-controller.ts:613

`Private` _trackExit

_trackExit(selection): void
Remove DOM-elements belonging to removed tracks
Parameters
- selection: any
  exit selection
Returns void
- Defined in ui/log-controller.ts:589

`Private` _trackUpdate

_trackUpdate(selection): void
Update DOM-elements for existing tracks
Parameters
- selection: any
  update selection
Returns void
- Defined in ui/log-controller.ts:691

addTrack

addTrack(track): LogController
Adds a single track to the log controller
Parameters
- track: Track<TrackOptions>
  track to be added
Returns LogController
- Defined in ui/log-controller.ts:167

adjustToSize

adjustToSize(force?): void
Rescale according to new container size
Parameters
- force: boolean = false
  Set to true in order to force update even if size has not changed
Returns void
- Defined in ui/log-controller.ts:215

`Protected` adjustTrackTitles

adjustTrackTitles(): void
Adjust track titles according to available space. Uses abbrievation istead of full label if not enough space.

Returns void
- Defined in ui/log-controller.ts:526

`Protected` adjustZoomTransform

adjustZoomTransform(): void
Recalculates transform based on new container size

Returns void
- Defined in ui/log-controller.ts:437

init

init(element): LogController
Convenience method if used stand-alone. Wraps onMount and returns self for chaining.
Parameters
- element: HTMLElement
  HTML element to attach itself to
Returns LogController
- Defined in ui/log-controller.ts:121

onMount

onMount(element): void
Initialize the component and attach itself to the provided DOM element.
Parameters
- element: HTMLElement
  HTML element to attach itself to
Returns void
- Defined in ui/log-controller.ts:130

onUnmount

onUnmount(): void
To unregister event listeners etc.

Returns void
- Defined in ui/log-controller.ts:140

`Protected` postUpdateTracks

postUpdateTracks(): void
Trigger onUpdate event after tracks has been altered in size

Returns void
- Defined in ui/log-controller.ts:544

`Protected` processLegendConfig

processLegendConfig(track, element): void
Processes track legend config object, creating the necessary DOM elements and hooking up callback functions etc.
Parameters
- track: Track<TrackOptions>
  Track to process
- element: Element
  Legend element
Returns void
- Defined in ui/log-controller.ts:386

refresh

refresh(): void
Force a redraw

Returns void
- Defined in ui/log-controller.ts:319

removeTrack

removeTrack(track): LogController
Removes a track from the log controller component
Parameters
- track: Track<TrackOptions>
  track to be removed
Returns LogController
- Defined in ui/log-controller.ts:190

rescale

rescale(): void
Notify all clients (tracks) on changes to domain/transform

Returns void
- Defined in ui/log-controller.ts:300

reset

reset(): LogController
Remove all tracks and update ui

Returns LogController
- Defined in ui/log-controller.ts:356

setTracks

setTracks(...track): LogController
Set the tracks for this controller, replacing any existing tracks
Parameters
- Rest ...track: Track<TrackOptions>[]
Returns LogController
- Defined in ui/log-controller.ts:150
setTracks(tracks): LogController
Parameters
- tracks: Track<TrackOptions>[]
Returns LogController
- Defined in ui/log-controller.ts:151

`Protected` setup

setup(element): void
Setup DOM elements, scale and behaviour
Parameters
- element: HTMLElement
  Html element to attach to
Returns void
- Defined in ui/log-controller.ts:365

`Protected` updateLegend

updateLegend(id): void
Updates the legend for a specific track
Parameters
- id: string | number
  Track id
Returns void
- Defined in ui/log-controller.ts:489

`Protected` updateLegendRows

updateLegendRows(): void
Determines the required number of rows in the legend section.

Returns void
- Defined in ui/log-controller.ts:466

updateTracks

updateTracks(): LogController
Update track-elements based on current registered track instances

Returns LogController
- Defined in ui/log-controller.ts:327

zoomTo

zoomTo(domain, duration?, callback?): LogController
Parameters
- domain: Domain
- duration: number = 0
- Optional callback: Function
Returns LogController
- Defined in ui/log-controller.ts:264

`Protected` zoomed

zoomed(event): void
Event handler for pan/zoom
Parameters
- event: any
Returns void
- Defined in ui/log-controller.ts:424

`Static` basic

basic(showTitles?): LogController
Simple creator function for minimal setup
Parameters
- showTitles: boolean = true
  optional flag to show titles or not
Returns LogController
- Defined in ui/log-controller.ts:109

Class LogController

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LogController

Properties

Private _deferredUpdate

Protected _initialized

Protected _legendHeight

Private _observer

Private _scaleHandler

Protected _titleFontSize

Protected _titleHeight

Protected _trackHeight

Protected _uiScale

container

debounce

height

legendRows

legends

Type declaration

[propName: string]: LegendMap

options

tracks

width

zoom

Accessors

domain

Returns Domain

Parameters

Returns void

innerBounds

Returns { length: number; span: number; }

length: number

span: number

scale

Returns Scale

scaleHandler

Returns ScaleHandler

Parameters

Returns void

zoomHandler

Returns any

Methods

Private _trackEnter

Parameters

Returns void

Private _trackExit

Parameters

Returns void

Private _trackUpdate

Parameters

Returns void

addTrack

Parameters

Returns LogController

adjustToSize

Parameters

Returns void

Protected adjustTrackTitles

Returns void

Protected adjustZoomTransform

Returns void

init

Parameters

Returns LogController

onMount

Parameters

Returns void

onUnmount

Returns void

Protected postUpdateTracks

Returns void

Protected processLegendConfig

`Private` _deferredUpdate

`Protected` _initialized

`Protected` _legendHeight

`Private` _observer

`Private` _scaleHandler

`Protected` _titleFontSize

`Protected` _titleHeight

`Protected` _trackHeight

`Protected` _uiScale

Returns {
length: number;
span: number;
}

`Private` _trackEnter

`Private` _trackExit

`Private` _trackUpdate

`Protected` adjustTrackTitles

`Protected` adjustZoomTransform

`Protected` postUpdateTracks

`Protected` processLegendConfig

`Protected` setup

`Protected` updateLegend

`Protected` updateLegendRows

`Protected` zoomed

`Static` basic