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

Dot

Extends:

BaseShape → Dot

A shape to display a dot.

example usage

Member Summary

Public Members
public

$el: *

Method Summary

Public Methods
public
public

inArea(renderingContext: *, datum: *, x1: *, y1: *, x2: *, y2: *): boolean

public

render(): *

public

update(renderingContext: *, datum: *)

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 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 inArea(renderingContext: *, datum: *, x1: *, y1: *, x2: *, y2: *): boolean source

Interface method to override called by Layer~getItemsInArea. Defines if the shape is considered to be the given area. Arguments are passed in pixel domain.

Override:

BaseShape#inArea

Params:

NameTypeAttributeDescription
renderingContext *
datum *
x1 *
y1 *
x2 *
y2 *

Return:

boolean

public render(): * source

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

Override:

BaseShape#render

Return:

*

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

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

Override:

BaseShape#update

Params:

NameTypeAttributeDescription
renderingContext *
datum *