Generates an arc for the given arguments.
IMPORTANT: If the rendering context of the arc generator is null, then the arc is returned as a path data string.
The "this" context within which this function is invoked, will be the context within which the accessor methods of the generator are invoked. All arguments passed into this function, will be passed to the accessor functions of the generator.
The datum for which the arc is to be generated.
Rest ...args: any[]Generates an arc for the given arguments.
IMPORTANT: If the arc generator has been configured with a rendering context, then the arc is rendered to this context as a sequence of path method calls and this function returns void.
The "this" context within which this function is invoked, will be the context within which the accessor methods of the generator are invoked. All arguments passed into this function, will be passed to the accessor functions of the generator.
The datum for which the arc is to be generated.
Rest ...args: any[]Computes the midpoint [x, y] of the center line of the arc that would be generated by the given arguments.
To be consistent with the generated arc, the accessors must be deterministic, i.e., return the same value given the same arguments. The midpoint is defined as (startAngle + endAngle) / 2 and (innerRadius + outerRadius) / 2.
Note that this is not the geometric center of the arc, which may be outside the arc; this method is merely a convenience for positioning labels.
The method is invoked in the same "this" context as the generator was invoked in and receives the same arguments that are passed into the arc generator.
The datum for which the arc is to be generated.
Rest ...args: any[]Returns the current rendering context, which defaults to null.
Sets the context and returns this arc generator. If context is not specified, returns the current context, which defaults to null.
Returns the current corner radius accessor, which defaults to a function returning a constant value of zero.
Returns the current corner radius accessor, which defaults to a function returning a constant value of zero.
Rest ...args: any[]Sets the corner radius to the specified number and returns this arc generator.
If the corner radius is greater than zero, the corners of the arc are rounded using circles of the given radius. For a circular sector, the two outer corners are rounded; for an annular sector, all four corners are rounded.
The corner radius may not be larger than (outerRadius - innerRadius) / 2. In addition, for arcs whose angular span is less than π, the corner radius may be reduced as two adjacent rounded corners intersect. This is occurs more often with the inner corners.
Constant radius.
Sets the corner radius to the specified function and returns this arc generator.
The corner radius may not be larger than (outerRadius - innerRadius) / 2. In addition, for arcs whose angular span is less than π, the corner radius may be reduced as two adjacent rounded corners intersect. This is occurs more often with the inner corners.
An accessor function returning a number to be used as a radius. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]Returns the current end angle accessor, which defaults to a function returning the endAngle property of the first argument passed into it.
Returns the current end angle accessor, which defaults to a function returning the endAngle property of the first argument passed into it.
Rest ...args: any[]Sets the end angle to the specified number and returns this arc generator.
The angle is specified in radians, with 0 at -y (12 o’clock) and positive angles proceeding clockwise. If |endAngle - startAngle| ≥ τ, a complete circle or annulus is generated rather than a sector.
Constant angle in radians.
Sets the end angle to the specified function and returns this arc generator.
The angle is specified in radians, with 0 at -y (12 o’clock) and positive angles proceeding clockwise. If |endAngle - startAngle| ≥ τ, a complete circle or annulus is generated rather than a sector.
An accessor function returning a number in radians to be used as an angle. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]Returns the current inner radius accessor, which defaults to a function returning the innerRadius property of the first argument passed into it.
Returns the current inner radius accessor, which defaults to a function returning the innerRadius property of the first argument passed into it.
Rest ...args: any[]Sets the inner radius to the specified number and returns this arc generator.
Specifying the inner radius as a function is useful for constructing a stacked polar bar chart, often in conjunction with a sqrt scale. More commonly, a constant inner radius is used for a donut or pie chart. If the outer radius is smaller than the inner radius, the inner and outer radii are swapped. A negative value is treated as zero.
Constant radius.
Sets the inner radius to the specified function and returns this arc generator.
Specifying the inner radius as a function is useful for constructing a stacked polar bar chart, often in conjunction with a sqrt scale. More commonly, a constant inner radius is used for a donut or pie chart. If the outer radius is smaller than the inner radius, the inner and outer radii are swapped. A negative value is treated as zero.
An accessor function returning a number to be used as a radius. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]Returns the current outer radius accessor, which defaults to a function returning the outerRadius property of the first argument passed into it.
Returns the current outer radius accessor, which defaults to a function returning the outerRadius property of the first argument passed into it.
Rest ...args: any[]Sets the outer radius to the specified number and returns this arc generator.
Specifying the outer radius as a function is useful for constructing a coxcomb or polar bar chart, often in conjunction with a sqrt scale. More commonly, a constant outer radius is used for a pie or donut chart. If the outer radius is smaller than the inner radius, the inner and outer radii are swapped. A negative value is treated as zero.
Constant radius.
Sets the outer radius to the specified function and returns this arc generator.
Specifying the outer radius as a function is useful for constructing a coxcomb or polar bar chart, often in conjunction with a sqrt scale. More commonly, a constant outer radius is used for a pie or donut chart. If the outer radius is smaller than the inner radius, the inner and outer radii are swapped. A negative value is treated as zero.
An accessor function returning a number to be used as a radius. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]Returns the current pad angle accessor, which defaults to a function returning the padAngle property of the first argument passed into it, or false if no data are passed in or the property is not defined.
Returns the current pad angle accessor, which defaults to a function returning the padAngle property of the first argument passed into it, or false if no data are passed in or the property is not defined.
Rest ...args: any[]Sets the pad angle to the specified number and returns this arc generator.
The pad angle is converted to a fixed linear distance separating adjacent arcs, defined as padRadius * padAngle. This distance is subtracted equally from the start and end of the arc. If the arc forms a complete circle or annulus, as when |endAngle - startAngle| ≥ τ, the pad angle is ignored. If the inner radius or angular span is small relative to the pad angle, it may not be possible to maintain parallel edges between adjacent arcs. In this case, the inner edge of the arc may collapse to a point, similar to a circular sector. For this reason, padding is typically only applied to annular sectors (i.e., when innerRadius is positive).
The recommended minimum inner radius when using padding is outerRadius * padAngle / sin(θ), where θ is the angular span of the smallest arc before padding. For example, if the outer radius is 200 pixels and the pad angle is 0.02 radians, a reasonable θ is 0.04 radians, and a reasonable inner radius is 100 pixels.
Often, the pad angle is not set directly on the arc generator, but is instead computed by the pie generator so as to ensure that the area of padded arcs is proportional to their value; see pie.padAngle. See the pie padding animation for illustration. If you apply a constant pad angle to the arc generator directly, it tends to subtract disproportionately from smaller arcs, introducing distortion.
Constant angle in radians.
Sets the pad angle to the specified function and returns this arc generator.
The pad angle is converted to a fixed linear distance separating adjacent arcs, defined as padRadius * padAngle. This distance is subtracted equally from the start and end of the arc. If the arc forms a complete circle or annulus, as when |endAngle - startAngle| ≥ τ, the pad angle is ignored. If the inner radius or angular span is small relative to the pad angle, it may not be possible to maintain parallel edges between adjacent arcs. In this case, the inner edge of the arc may collapse to a point, similar to a circular sector. For this reason, padding is typically only applied to annular sectors (i.e., when innerRadius is positive).
The recommended minimum inner radius when using padding is outerRadius * padAngle / sin(θ), where θ is the angular span of the smallest arc before padding. For example, if the outer radius is 200 pixels and the pad angle is 0.02 radians, a reasonable θ is 0.04 radians, and a reasonable inner radius is 100 pixels.
Often, the pad angle is not set directly on the arc generator, but is instead computed by the pie generator so as to ensure that the area of padded arcs is proportional to their value; see pie.padAngle. See the pie padding animation for illustration. If you apply a constant pad angle to the arc generator directly, it tends to subtract disproportionately from smaller arcs, introducing distortion.
An accessor function returning a number in radians to be used as an angle. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]Returns the current pad radius accessor, which defaults to null, indicating that the pad radius should be automatically computed as sqrt(innerRadius * innerRadius + outerRadius * outerRadius).
Rest ...args: any[]Sets the pad radius to the specified function or number and returns this arc generator. The pad radius determines the fixed linear distance separating adjacent arcs, defined as padRadius * padAngle.
Returns the current start angle accessor, which defaults to a function returning the startAngle property of the first argument passed into it.
Returns the current start angle accessor, which defaults to a function returning the startAngle property of the first argument passed into it.
Rest ...args: any[]Sets the start angle to the specified number and returns this arc generator.
The angle is specified in radians, with 0 at -y (12 o’clock) and positive angles proceeding clockwise. If |endAngle - startAngle| ≥ τ, a complete circle or annulus is generated rather than a sector.
Constant angle in radians.
Sets the start angle to the specified function and returns this arc generator.
The angle is specified in radians, with 0 at -y (12 o’clock) and positive angles proceeding clockwise. If |endAngle - startAngle| ≥ τ, a complete circle or annulus is generated rather than a sector.
An accessor function returning a number in radians to be used as an angle. The accessor function is invoked in the same "this" context as the generator was invoked in and receives the same arguments that were passed into the arc generator.
Rest ...args: any[]
The arc generator produces a circular or annular sector, as in a pie or donut chart.
If the difference between the start and end angles (the angular span) is greater than τ, the arc generator will produce a complete circle or annulus. If it is less than τ, arcs may have rounded corners and angular padding. Arcs are always centered at ⟨0,0⟩; use a transform (see: SVG, Canvas) to move the arc to a different position.
See also the pie generator, which computes the necessary angles to represent an array of data as a pie or donut chart; these angles can then be passed to an arc generator.
The first generic corresponds to the type of the "this" context within which the arc generator and its accessor functions will be invoked.
The second generic corresponds to the datum type for which the arc is to be generated.