Home Manual Reference Source Repository
import AxisLayer from 'waves-ui/src/axis/axis-layer.js'
public class | source

AxisLayer

Extends:

src/core/layer~Layer → AxisLayer

Simplified Layer for Axis. The main difference with a regular layer is that an axis layer use the Timeline~timeContext attributes to render it's layout and stay synchronized with the tracks visible area. All getters and setters to the TimelineTimeContext attributes are bypassed.

It also handle it's own data and its updates. The _generateData method is responsible to create some usefull data to visualize

example usage of the layer-axis

Constructor Summary

Public Constructor
public

constructor(generator: Function, options: Object)

Member Summary

Public Members
public
public
public
public set

The generator that creates the data to be rendered to display the axis.

public get

The generator that creates the data to be rendered to display the axis.

Method Summary

Public Methods
public

update()

Generates the data and update the layer.

public

Updates the layout of the layer.

Public Constructors

public constructor(generator: Function, options: Object) source

Params:

NameTypeAttributeDescription
generator Function

A function to create data according to the Timeline~timeContext.

options Object

Layer options, cf. Layer for available options.

Public Members

public $background: Element source

public $el: Element source

public $offset: Element source

public set generator: Function source

The generator that creates the data to be rendered to display the axis.

public get generator: Function source

The generator that creates the data to be rendered to display the axis.

Public Methods

public update() source

Generates the data and update the layer.

public updateContainer() source

Updates the layout of the layer.