RectPath

extends Path

The RectPath class represents a rectangular mark. To create a RectPath object, use the mark method in the Scene class, for example:

    let rect = scene.mark("rect", {top: 50, left: 100, width: 200, height: 80, fillColor: "blue"});

property	explanation	type	default value
left	the x coordinate of the left hand side of the rectangle	Number	0
top	the y coordinate of the top of the rectangle	Number	0
right	the x coordinate of the right hand side of the rectangle	Number
bottom	the y coordinate of the bottom of the rectangle	Number
width	the width of the rectangle	Number	100
height	the height of the rectangle	Number	100
area	the area of the rectangle	Number
topSegment	the top segment of the rectangle	Segment
rightSegment	the right segment of the rectangle	Segment
bottomSegment	the bottom segment of the rectangle	Segment
leftSegment	the left segment of the rectangle	Segment

property	explanation	type	default value
bounds	the bounding rectangle of the path	Rectangle
x	the x coordinate of the center of the path bounds	Number
y	the y coordinate of the center of the path bounds	Number
curveMode	how the segments are drawn	String	“linear”
vertices	the vertices along the path	Array
segments	the segments on the path	Array
firstVertex	returns the first vertex of the path	Vertex
firstSegment	returns the first segment of the path	Segment
fillColor	the fill color of the path if it is closed	Color	undefined
strokeColor	the stroke color of the path	Color	“#ccc”
strokeDash	the dashes and gaps for the path stroke	String	“none”
strokeWidth	the stroke width of the path in pixels	Number	1
opacity	the opacity value of the path (between 0 and 1)	Number	1
vxShape	the shape of the vertices on this path possible values: “rect”, “circle”	String	undefined
vxWidth	the width of the vertices on this path	Number	0
vxHeight	the height of the vertices on this path	Number	0
vxRadius	the radius of the vertices on this path if the shape is “circle”	Number	0
vxFillColor	the fill color of the vertices on this path	Color	“#555”
vxStrokeColor	the stroke color of the vertices on this path	Color	“#aaa”
vxStrokeWidth	the stroke width of the vertices on this path in pixels	Number	0
vxOpacity	the opacity of the vertices on this path	Number	1

property	explanation	type	default value
id	the unique id of the path	String
type	the type of the path	String	“rect”
dataScope	the data scope of the path	DataScope	undefined
opacity	the opacity value of the path (between 0 and 1)	Number	1
visibility	whether the path is visible (“visible” or “hidden”)	String	“visible”

method	explanation	return type
resize(wd, ht)	change the width and height of the rectangle	void

method	explanation	return type
getSVGPathData()	returns a string to be used as the d parameter in an SVG path element	String

method	explanation	return type
contains(x, y)	whether this mark contains a point x (Number): x coordinate of the point y (Number): y coordinate of the point	Boolean
getScene()	returns the scene in which this mark resides	Scene
duplicate()	returns a copy of this mark	RectPath