`class` LinePlot `extends Band`

Band type that plots a line along the timeline.

Properties

background getset

Background of this band.

Type:: FillStyle

borderColor getset

Border color of this band. If undefined, the color is determined by the property ‘bandBorderColor’ of the Timeline instance.

Type:: undefined | string

borderWidth getset

Border width of this band. If undefined, the width is determined by the property ‘bandBorderWidth’ of the Timeline instance.

Type:: undefined | number

contentHeight getset

The height of the band content (excluding margins).

Type:: number
Default value:: 30

data getset

Arbitrary data. For example an identifier of a backend system.

Type:: any

fill getset

Area fill between the plot line and the value 0.

Type:: FillStyle
Default value:: 'transparent'

frozen getset

If set to true, this band stays fixed on top, even while scrolling vertically.

Frozen bands precede non-frozen bands, regardless of the order in which bands were added.

Type:: boolean

headerBackground getset

Background of the header of this band.

Type:: FillStyle

height get

The height of this band.

Type:: number

label getset

Human-friendly label for this band. Used in sidebar.

Type:: undefined | string

labelBackground getset

Background color of any value labels.

Type:: FillStyle
Default value:: 'transparent'

labelFontFamily getset

Font family of any value labels.

Type:: string
Default value:: 'Verdana, Geneva, sans-serif'

labelFormatter getset

Function that formats a point value to string.

The default behaviour is to format with 2 digits after the decimal point.

Type:: (value: number) => string

labelTextColor getset

Text color of any value labels.

Type:: string
Default value:: '#333333'

labelTextSize getset

Size of any value labels.

Type:: number
Default value:: 8

lineColor getset

Color of the line that connects data points.

Type:: string
Default value:: '#4f9146'

lineWidth getset

Thickness of the plot line.

Type:: number
Default value:: 1

lines getset

Type:: Line[]
Default value:: []

marginBottom getset

Whitespace in points between the bottom of this band and band content.

Type:: number

marginTop getset

Whitespace in points between the top of this band and band content.

Type:: number

maximum getset

Value that corresponds with the maximum value on the curve. If undefined, the value is automatically derived from the plot data.

Type:: undefined | number

minimum getset

Value that corresponds with the minimum value on the curve. If undefined, the value is automatically derived from the plot data.

Type:: undefined | number

pointColor getset

Color of the point symbol.

Type:: string
Default value:: '#4f9146'

pointHoverRadius getset

Radius of the point symbol when hovered.

Type:: number
Default value:: 4

pointRadius getset

Radius of the point symbol.

Type:: number
Default value:: 1.5

timeline get

Timeline instance that this instance is bound to.

Type:: Timeline

width get

The width of this band.

Type:: number

x get

The X-coordinate of this band.

Type:: number

y get

The Y-coordinate of this band.

Type:: number

zeroLineColor getset

Color of the line at value zero.

Type:: string
Default value:: '#e8e8e8'

zeroLineDash getset

Dash pattern of the line at value zero.

Type:: number[]

zeroLineWidth getset

Width of the line at value zero.

Type:: number
Default value:: 0

Methods

constructor(timeline)

Parameters:

Timeline timeline
Timeline instance that this instance is bound to.

addHeaderClickListener(listener)

Parameters:

(ev: HeaderClickEvent) => void listener

Return type:

void

addMutationListener(mutationListener)

Adds a listener that is notified whenever one of the properties changes.

This method is used by the Timeline instance to detect when to redraw the Canvas.

Parameters:

() => void mutationListener

Return type:

void

addPointClickListener(listener)

Parameters:

(ev: PointClickEvent) => void listener

Return type:

void

addPointHoverListener(listener)

Parameters:

(ev: PointHoverEvent) => void listener

Return type:

void

beforeDraw(g)

Gets called before any of the draw methods.

Parameters:

Graphics g

Return type:

void

calculateContentHeight(g)

Implementations should return required content height (excluding margins) during the current draw operation.

Parameters:

Graphics g

Return type:

number

createAnimatableProperty(value)

Creates an animatable property.

Animatable properties apply easing over time between numeric value changes.

Parameters:

number value –

Return type:

AnimatableProperty

disconnectedCallback()

Called when this drawable is removed from its Timeline

Return type:: void

drawBandContent(g)

Parameters:

Graphics g

Return type:

void

drawContent(g)

Draw regular content.

Parameters:

Graphics g

Return type:

void

drawOverlay(g)

Gets called after regular content is drawn. Override this if you need a top layer.

Parameters:

Graphics g

Return type:

void

drawUnderlay(g)

Gets called before regular content is drawn. Override this if you need a bottom layer.

Parameters:

Graphics g

Return type:

void

removeHeaderClickListener(listener)

Unregister a previously registered listener to stop receiving header click events.

Parameters:

(ev: HeaderClickEvent) => void listener

Return type:

void

removeMutationListener(mutationListener)

Remove a previously added mutation listener.

Parameters:

() => void mutationListener

Return type:

void

removePointClickListener(listener)

Unregister a previously registered listener to stop receiving click events.

Parameters:

(ev: PointClickEvent) => void listener

Return type:

void

removePointHoverListener(listener)

Unregister a previously registered listener to stop receiving hover events.

Parameters:

(ev: PointHoverEvent) => void listener

Return type:

void

reportMutation()

Mark this Drawable as dirty. This method is intended for use in subclasses and should be called in the implementation of set accessors.

Return type:: void

class LinePlot extends Band

Properties

Methods

Drawables

`class` LinePlot `extends Band`