Rect

extends Path

The Rect class represents a rectangular mark. To create a Rect 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"});

Properties

propertyexplanationtypedefault value
area the area of the rectangleNumber
bottom the y coordinate of the bottom of the rectangleNumber
bottomSegment the bottom segment of the rectangleSegment
heightthe height of the rectangleNumber100
leftthe x coordinate of the left hand side of the rectangleNumber0
leftSegment the left segment of the rectangleSegment
right the x coordinate of the right hand side of the rectangleNumber
rightSegment the right segment of the rectangleSegment
topthe y coordinate of the top of the rectangleNumber0
topSegment the top segment of the rectangleSegment
widththe width of the rectangleNumber100

Properties inherited from Path

propertyexplanationtypedefault value
curveModehow the segments are drawnString“linear”
firstSegment returns the first segment of the pathSegment
firstVertex returns the first vertex of the pathVertex
segments the segments on the pathArray
vertices the vertices along the pathArray
vxFillColorthe fill color of the vertices on this pathColor“#555555”
vxHeightthe height of the vertices on this pathNumber0
vxOpacitythe opacity of the vertices on this pathNumber1
vxRadiusthe radius of the vertices on this path if the shape is “circle”Number0
vxShapethe shape of the vertices on this path
possible values: “rect”, “circle”
Stringundefined
vxStrokeColorthe stroke color of the vertices on this pathColor“#aaaaaa”
vxStrokeWidththe stroke width of the vertices on this path in pixelsNumber0
vxWidththe width of the vertices on this pathNumber0
x the x coordinate of the center of the path boundsNumber
y the y coordinate of the center of the path boundsNumber

Properties inherited from Mark

propertyexplanationtypedefault value
bounds the bounding rectangle of the markRectangle
dataScopethe data scope of the markDataScopeundefined
fillColorthe fill color of the markColor“#fff”
id the unique id of the markString
opacitythe opacity value of the mark (between 0 and 1)Number1
strokeColorthe stroke color of the markColor“#ccc”
strokeDashthe dashes and gaps for the mark strokeString“none”
strokeWidththe stroke width of the mark in pixelsNumber1
type the type of the markString“rect”
visibilitywhether the mark is visible (“visible” or “hidden”)String“visible”

Methods

methodexplanationreturn type
resize(wd, ht)change the width and height of the rectanglevoid

Methods inherited from Path

methodexplanationreturn type
getSVGPathData()returns a string to be used as the d parameter in an SVG path elementString