import Crosshairs from 'waves-ui-piper/src/shapes/crosshairs.js'

public class | source

Crosshairs

Extends:

BaseShape → Crosshairs

A shape to display labelled crosshairs or similar positional crosshairs/focus overlay.

example usage

Member Summary

Public Members
public	$el: *
public	$labels: undefined[]
public	$path: *
public	lastCx: *
public	lastCy: *

Method Summary

Public Methods
public	getClassName(): string
public	inArea(): Boolean The crosshairs cannot be selected.
public	render(renderingContext: ):
public	update(renderingContext: , datum: )

Inherited Summary

From class BaseShape
public	$el: Element
public	[key]: *
public	[name]: *
public	ns: String
public	params: Object
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() 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	getClassName(): String 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	_getAccessorList(): Object Returns an object where keys are the accessors methods names to create and values are the default values for each given accessor.
protected	_getDefaults(): Object Returns the defaults for global configuration of the shape.

Public Members

public $el: * source

Override:

BaseShape#$el

public $labels: undefined[] source

public $path: * source

public lastCx: * source

public lastCy: * source

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(): Boolean source

The crosshairs cannot be selected.

Override:

BaseShape#inArea

Return:

Boolean

false

public render(renderingContext: ): source

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

Override:

BaseShape#render

Params:

Name	Type	Attribute	Description
renderingContext	*

Return:

public update(renderingContext: , datum: ) source

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

Override:

BaseShape#update

Params:

Name	Type	Attribute	Description
renderingContext	*
datum	*

Crosshairs

Extends:

Member Summary

Method Summary

Inherited Summary

Public Members

public $el: * source

Override:

public $labels: undefined[] source

public $path: * source

public lastCx: * source

public lastCy: * source

Public Methods

public getClassName(): string source

Override:

Return:

public inArea(): Boolean source

Override:

Return:

public render(renderingContext: *): * source

Override:

Params:

Return:

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

Override:

Params:

public render(renderingContext: ): source

public update(renderingContext: , datum: ) source