Class: VectorObject

Constructor

new VectorObject(path, fill, fill_rule, stroke, stroke_width, stroke_line_cap, stroke_line_join, stroke_miter_limit, stroke_dash_offset, stroke_dash_array, children, name, transform)

Creates a new VectorObject.

Parameters:

Name	Type	Description
`path`	Path2D	The Path2D of the vector object.
`fill`	Style	The fill Style of the vector object.
`fill_rule`	string	The fill rule of the vector object.
`stroke`	Style	The stroke Style of the vector object.
`stroke_width`	number	The stroke width of the vector object.
`stroke_line_cap`	string	The stroke line cap of the vector object.
`stroke_line_join`	string	The stroke line join of the vector object.
`stroke_miter_limit`	number	The stroke miter limit of the vector object.
`stroke_dash_offset`	number	The stroke dash offset of the vector object.
`stroke_dash_array`	Array.<number>	The stroke dash array of the vector object.
`children`	Array.<VectorObject>	The children of the vector object.
`name`	string \| null \| undefined	The name of the vector object.
`transform`	TransformationMatrix	The TransformationMatrix of the vector object.

Source: pkg/index.js, line 4718

Classes

VectorObject

Members

actual_path

Gets the Path2D with the applied TransformationMatrix.

Source: pkg/index.js, line 4945

center

Gets the center Point2D of the VectorObject.

Source: pkg/index.js, line 4962

children

Gets the children of the VectorObject.

Source: pkg/index.js, line 4914

fill

Gets the fill Style of the VectorObject.

Source: pkg/index.js, line 4816

fill_rule

Gets the fill rule of the VectorObject.

Source: pkg/index.js, line 4824

height

Gets the height of the VectorObject.

Source: pkg/index.js, line 5042

is_closed

Gets whether the VectorObject's path is closed.

Source: pkg/index.js, line 5016

name

Gets the name of the VectorObject.

Source: pkg/index.js, line 4924

num_children

Gets the number of children in the VectorObject.

Source: pkg/index.js, line 5008

num_curves

Gets the number of cubic bezier curves in the vector object.

Source: pkg/index.js, line 4992

num_points

Gets the number of points in the VectorObject's path.

Source: pkg/index.js, line 5000

path

Gets the Path2D of the VectorObject.

Source: pkg/index.js, line 4808

stroke

Gets the stroke Style of the VectorObject.

Source: pkg/index.js, line 4840

stroke_dash_array

Gets the stroke dash array of the VectorObject.

Source: pkg/index.js, line 4904

stroke_dash_offset

Gets the stroke dash offset of the VectorObject.

Source: pkg/index.js, line 4896

stroke_line_cap

Gets the stroke line cap of the VectorObject.

Source: pkg/index.js, line 4856

stroke_line_join

Gets the stroke line join of the VectorObject.

Source: pkg/index.js, line 4872

stroke_miter_limit

Gets the stroke miter limit of VectorObject.

Source: pkg/index.js, line 4888

stroke_width

Gets the stroke width of the VectorObject.

Source: pkg/index.js, line 4848

subpaths

Gets the subpaths of the VectorObject.

Source: pkg/index.js, line 5024

transform

Gets the transformation matrix of the VectorObject.

Source: pkg/index.js, line 4937

width

Gets the width of the VectorObject.

Source: pkg/index.js, line 5034

Methods

bounding_box(recursiveopt) → {BoundingBox|undefined}

Gets the BoundingBox of the VectorObject.

Parameters:

Name	Type	Attributes	Description
`recursive`	boolean \| null	<optional>	Whether to include the children of the vector object.

Source: pkg/index.js, line 4954

Returns:

The bounding box of the vector object.

Type:: BoundingBox | undefined

clone() → {VectorObject}

Clones the vector object.

Source: pkg/index.js, line 4792

Returns:

The cloned vector object.

Type:: VectorObject

get_children_by_names(names) → {Array.<VectorObject>}

Gets the children of the VectorObject with the given names.

Parameters:

Name	Type	Description
`names`	Array.<string>	The names of the children to get.

Source: pkg/index.js, line 5063

Returns:

The children with the given names.

Type:: Array.<VectorObject>

get_children_recursive(with_pointsopt) → {Array.<VectorObject>}

Gets the children of the VectorObject recursively.

Parameters:

Name	Type	Attributes	Description
`with_points`	boolean \| null	<optional>	Whether to include the children of the children of the vector object, default is false.

Source: pkg/index.js, line 4982

Returns:

The children of the vector object.

Type:: Array.<VectorObject>

get_critical_point(key_x, key_y, recursiveopt) → {Point2D|undefined}

Gets the critical Point2D of the VectorObject.

Parameters:

Name	Type	Attributes	Description
`key_x`	number		The x key of the critical point. If negative, the minimum x is returned. If positive, the maximum x is returned. If zero, the center x is returned.
`key_y`	number		The y key of the critical point. If negative, the minimum y is returned. If positive, the maximum y is returned. If zero, the center y is returned.
`recursive`	boolean \| null	<optional>	Whether to include the children of the vector object.

Source: pkg/index.js, line 4973

Returns:

The critical point of the vector object.

Type:: Point2D | undefined

slice_children(start, end) → {Array.<VectorObject>}

Slices the VectorObject's children.

Parameters:

Name	Type	Description
`start`	number	The start index of the children to slice.
`end`	number	The end index of the children to slice.

Source: pkg/index.js, line 5052

Returns:

The sliced children of the vector object.

Type:: Array.<VectorObject>

(static) default_vector_object() → {VectorObject}

Creates a new empty VectorObject.

Source: pkg/index.js, line 4800

Returns:

A new empty vector object.

Type:: VectorObject