Ring

extends Path

The Ring class represents a ring mark that is used in a Doughnut Chart and a Sunburst Chart. To create a Ring object, use the mark method in the Scene class, for example:

    let ring = scene.mark("ring", {x: 50, y: 100, innerRadius: 20, outerRadius: 40});

Properties#

property	explanation	type	default value
innerRadius	the inner radius of the ring	Number	100
outerRadius	the outer radius of the ring	Number	200
thickness	the difference between the outer radius and inner radius	Number	100
x	the x coordinate of the center of the ring	Number	0
y	the y coordinate of the center of the ring	Number	0

Properties inherited from Path#

property	explanation	type	default value
firstSegment	returns the first segment of the path	Segment
firstVertex	returns the first vertex of the path	Vertex
segments	the segments on the path	Array of Segment
vertices	the vertices along the path	Array of Vertex
vxFillColor	the fill color of the vertices on this path	Color	“#555555”
vxHeight	the height of the vertices on this path	Number	0
vxOpacity	the opacity of the vertices on this path	Number	1
vxRadius	the radius of the vertices on this path if the shape is “circle”	Number	0
vxShape	the shape of the vertices on this path possible values: “rect”, “circle”	String	undefined
vxStrokeColor	the stroke color of the vertices on this path	Color	“#aaaaaa”
vxStrokeWidth	the stroke width of the vertices on this path in pixels	Number	0
vxWidth	the width of the vertices on this path	Number	0

Properties inherited from Mark#

property	explanation	type	default value
bounds	the bounding rectangle of the mark	Rectangle
dataScope	the data scope of the mark	DataScope	undefined
fillColor	the fill color of the mark	Color	“none”
id	the unique id of the mark	String
opacity	the opacity value of the mark (between 0 and 1)	Number	1
strokeColor	the stroke color of the mark	Color	“#ccc”
strokeDash	the dashes and gaps for the mark stroke	String	“none”
strokeWidth	the stroke width of the mark in pixels	Number	1
type	the type of the mark	String	“ring”
visibility	whether the mark is visible (“visible” or “hidden”)	String	“visible”

Methods#