Home Manual Reference Source Repository 
import Line from 'waves-ui-piper/src/shapes/line.js'
public class | source

Line

Extends:

BaseShape → Line

A shape to display a line. Its main use is as common shape to create a breakpoint visualization. (entity shape)

example usage

Member Summary

Public Members
public

$el: *

Method Summary

Public Methods
public

describe(data: *, t: *): undefined[]

public

encache(data: *): *

public
public

render(renderingContext: *): *

public

update(renderingContext: *, data: *)

Inherited Summary

From class BaseShape
public
public

[key]: *

public

[name]: *

public
public
public

describe(datum: *, x: *): *[]

Interface method that returns a value or description for salient features of the shape at the given x-coordinate (in time).
public

Destroy the shape and clean references.
public

encache(datum: Object | Array): Object

Interface method called by Layer~update, only for shapes with entity type.
public

Interface method to override when extending this base class.
public

inArea(renderingContext: Object, datum: Object | Array, x1: Number, y1: Number, x2: Number, y2: Number): Boolean

Interface method to override called by Layer~getItemsInArea.
public

install(accessors: Object<String, function>)

Interface method called by Layer when creating a shape.
public

render(renderingContext: Object): Element

Interface method called by Layer~render.
public

update(renderingContext: Object, datum: Object | Array)

Interface method called by Layer~update.
protected

Returns an object where keys are the accessors methods names to create and values are the default values for each given accessor.
protected

Returns the defaults for global configuration of the shape.

Public Members

public $el: * source

Override:

BaseShape#$el

Public Methods

public describe(data: *, t: *): undefined[] source

Interface method that returns a value or description for salient features of the shape at the given x-coordinate (in time).

The return value should be an array of objects each having properties "cy" (y-coord, i.e. underlying value of datum at or nearest to the given time), "cx" (x-coord in time of that datum) and optionally "unit" (unit of value as a string).

Override:

BaseShape#describe

Params:

NameTypeAttributeDescription
data *
t *

Return:

undefined[]

public encache(data: *): * source

Interface method called by Layer~update, only for shapes with entity type.

Called once for a given entity, to return any information derived from it that will be used subsequently when rendering. If this method returns a non-null object, then that object will be passed to the update method subsequently instead of the original entity datum. (If you want to retain access to the original entity, stash it in your cache object as well. Otherwise it may be GC'd if nobody else needs it.)

Override:

BaseShape#encache

Params:

NameTypeAttributeDescription
data *

Return:

*

public getClassName(): string source

Interface method to override when extending this base class. The method is called by the Layer~render method. Returns the name of the shape, used as a class in the element group (defaults to 'shape').

Override:

BaseShape#getClassName

Return:

string

public render(renderingContext: *): * source

Interface method called by Layer~render. Creates the DOM structure of the shape.

Override:

BaseShape#render

Params:

NameTypeAttributeDescription
renderingContext *

Return:

*

public update(renderingContext: *, data: *) source

Interface method called by Layer~update. Updates the DOM structure of the shape.

Override:

BaseShape#update

Params:

NameTypeAttributeDescription
renderingContext *
data *