AreaPath

extends Path

The AreaPath class represents an enclosed area mark that is used in visualizations such as the area chart and the violin plot. You cannot create an AreaPath object directly, instead, you need to use the densify method in the Scene class to transform a RectPath to an AreaPath. Here is an explanation of the densify operation. The figure below shows how AreaPath objects are created from a RectPath object through the densify operation.

AreaPath

Properties

propertyexplanationtypedefault value
width the width of the areaNumber
height the height of the areaNumber
left the x coordinate of the first vertexNumber
top the y coordinate of the first vertexNumber
orientation the orientation of the areaString
firstVertexPair the first pair of the vertices (highlighted in red in the figure above)Array of Vertex

Properties inherited from Path

propertyexplanationtypedefault value
bounds the bounding rectangle of the pathRectangle
x the x coordinate of the center of the path boundsNumber
y the y coordinate of the center of the path boundsNumber
curveModehow the segments are drawnString
vertices the vertices along the pathArray
segments the segments on the pathArray
firstVertex returns the first vertex of the pathVertex
firstSegment returns the first segment of the pathSegment
fillColorthe fill color of the path if it is closedColorundefined
strokeColorthe stroke color of the pathColor“#ccc”
strokeDashthe dashes and gaps for the path strokeString“none”
strokeWidththe stroke width of the path in pixelsNumber1
opacitythe opacity value of the path (between 0 and 1)Number1
vxShapethe shape of the vertices on this path
possible values: “rect”, “circle”
Stringundefined
vxWidththe width of the vertices on this pathNumber0
vxHeightthe height of the vertices on this pathNumber0
vxRadiusthe radius of the vertices on this path if the shape is “circle”Number0
vxFillColorthe fill color of the vertices on this pathColor“#555”
vxStrokeColorthe stroke color of the vertices on this pathColor“#aaa”
vxStrokeWidththe stroke width of the vertices on this path in pixelsNumber0
vxOpacitythe opacity of the vertices on this pathNumber1

Properties inherited from Mark

propertyexplanationtypedefault value
id the unique id of the pathString
type the type of the pathString“area”
dataScopethe data scope of the pathDataScopeundefined
opacitythe opacity value of the path (between 0 and 1)Number1
visibilitywhether the path is visible (“visible” or “hidden”)String“visible”

Methods inherited from Path

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

Methods inherited from Mark

methodexplanationreturn 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 residesScene
duplicate()returns a copy of this markRectPath