Class: Axis

Constructor

new Axis(range, render_start, render_end, labelopt, ticksopt, styleopt, stroke_widthopt)

Creates a new Axis with the given range and label.

Parameters:

Name	Type	Attributes	Description
`range`	ClosedInterval		The range of the axis.
`render_start`	Point2D		The minimum coordinates of the axis when rendered.
`render_end`	Point2D		The maximum coordinates of the axis when rendered.
`label`	VectorObjectBuilder \| null	<optional>	The label of the axis.
`ticks`	Array.<Tick> \| null	<optional>	The ticks of the axis.
`style`	Style \| null	<optional>	The style of the axis.
`stroke_width`	number \| null	<optional>	The stroke width of the axis.

Source: pkg/index.js, line 570

Classes

Axis

Members

label

Returns the label of the axis.

Source: pkg/index.js, line 653

num_ticks

Returns the number of ticks on the axis.

Source: pkg/index.js, line 679

range

Returns the range of the axis.

Source: pkg/index.js, line 629

render_end

Returns the maximum x-coordinate of the axis when rendered.

Source: pkg/index.js, line 645

render_start

Returns the minimum x-coordinate of the axis when rendered.

Source: pkg/index.js, line 637

style

Returns the style of the axis.

Source: pkg/index.js, line 671

ticks

Returns the ticks of the axis.

Source: pkg/index.js, line 661

Methods

clone() → {Axis}

Clones the axis.

Source: pkg/index.js, line 789

Returns:

Type:: Axis

coord_to_point(num) → {Point2D}

Gets the coordinates of a point in the axis.

Parameters:

Name	Type	Description
`num`	number

Source: pkg/index.js, line 697

Returns:

The coordinates of the point in the axis.

Type:: Point2D

point_to_coord(point) → {number}

Gets the value of a point in the axis.

Parameters:

Name	Type	Description
`point`	Point2D

Source: pkg/index.js, line 706

Returns:

The value of the point in the axis.

Type:: number

tick(num) → {Tick|undefined}

Returns the tick at the given number.

Parameters:

Name	Type	Description
`num`	number	The number coo

Source: pkg/index.js, line 688

Returns:

The tick at the given number.

Type:: Tick | undefined

vector_object_builder(label_directionopt, label_offsetopt, tick_label_directionopt, tick_label_offsetopt, add_labelopt) → {VectorObjectBuilder}

Gets the VectorObjectBuilder such that when built and rendered, the axis is drawn.

Parameters:

Name	Type	Attributes	Description
`label_direction`	Point2D \| null	<optional>	The direction of the label. The default is (1, 0).
`label_offset`	number \| null	<optional>	The offset of the label. The default is 20.0.
`tick_label_direction`	Point2D \| null	<optional>	The direction of the tick label. The default is (0, 1).
`tick_label_offset`	number \| null	<optional>	The offset of the tick label. The default is 10.0.
`add_label`	boolean \| null	<optional>	Whether to add the axis label. The default is true.

Source: pkg/index.js, line 721

Returns:

A vector object builder with the axis.

Type:: VectorObjectBuilder

with_tip_at_the_end(tip_shape, label_directionopt, label_offsetopt, tick_label_directionopt, tick_label_offsetopt) → {VectorObjectBuilder}

Returns the VectorObjectBuilder with the axis and tip at the end.

Parameters:

Name	Type	Attributes	Description
`tip_shape`	VectorObjectBuilder		The shape of the tip. The shape must be pointing to the right and centered to (0, 0), this function will rotate and move it to the correct angle.
`label_direction`	Point2D \| null	<optional>	The direction of the label. The default is (1, 0).
`label_offset`	number \| null	<optional>	The offset of the label. The default is 20.0.
`tick_label_direction`	Point2D \| null	<optional>	The direction of the tick label. The default is (0, 1).
`tick_label_offset`	number \| null	<optional>	The offset of the tick label. The default is 10.0.

Source: pkg/index.js, line 744

Returns:

A VectorObjectBuilder with the axis and tip at the end.

Type:: VectorObjectBuilder

with_tips_at_both_ends(tip_shape, label_directionopt, label_offsetopt, tick_label_directionopt, tick_label_offsetopt) → {VectorObjectBuilder}

Returns the VectorObjectBuilder with the axis and tips at both ends.

Parameters:

Name	Type	Attributes	Description
`tip_shape`	VectorObjectBuilder		The shape of the tip. The shape must be pointing to the right, this function will rotate and move it to the correct angle.
`label_direction`	Point2D \| null	<optional>	The direction of the label. The default is (1, 0).
`label_offset`	number \| null	<optional>	The offset of the label. The default is 20.0.
`tick_label_direction`	Point2D \| null	<optional>	The direction of the tick label. The default is (0, 1).
`tick_label_offset`	number \| null	<optional>	The offset of the tick label. The default is 10.0.

Source: pkg/index.js, line 769

Returns:

A VectorObjectBuilder with the axis and tips at both ends.

Type:: VectorObjectBuilder