Categories &

Functions List

Class Definition: PolarAreaData

chartjs: obj = PolarAreaData (data)

Create a PolarAreaData object.

obj = PolarAreaData (data) returns a PolarAreaData object, in which data must be a nonempty numerical vector containing the radii of the arc segments of a single dataset. Constructing a PolarAreaData object always assigns the default property values, which can later be modified using dot notation syntax.

A PolarAreaData object, obj, contains the following properties:

FieldDescription
backgroundColorA Color object defining the color of the face of the arc segments. Default is empty, in which case and a color is assigned automatically by the Chart.js library.
borderAlignA character vector, which can be either 'center' (default) or 'inner'. When 'center' is set, the borders of arcs next to each other will overlap. When 'inner' is set, it is guaranteed that all borders will not overlap.
borderColorA Color object defining the color of the border line of the arc segments. Default is empty, in which case a color is assigned automatically by the Chart.js library.
borderDashA numeric vector defining the length and spacing of dashes drawn at the borders of the arc segments.
borderDashOffsetA numeric scalar defining the offset of dashes drawn at the borders of the arc segments. Default is 0.
borderJoinStyleA character vector defining the arc border join style. It can be either 'round', 'bevel', or 'miter'.
borderWidthA numeric scalar value defining the width of the each arc segment’s borders in pixels. Default is 2.
circularA boolean scalar value defining whether the arc will be curved or flat. By default, it is true corresponding to curved arc segments.
clipA numeric scalar value defining the pixels to clip relative to the chart’s area. Positive value allows overflow, negative value clips that many pixels inside chartArea. Defaults to zero pixels.
dataA numeric vector assigned at construction of the PolarAreaData object. It cannot be empty.
hoverBackgroundColorA Color object defining the color of the face of each arc segment, when the mouse hovers over it. Default is empty, in which case the color is the same as in backgroundColor.
hoverBorderColorA Color object defining the color of the borders of each arc segment, when the mouse hovers over it. Default is empty, in which case the color is the same as in borderColor.
hoverBorderDashA numeric vector defining the length and spacing of dashes drawn at the borders of the arc segment, when the mouse hovers over it.
hoverBorderDashOffsetA numeric scalar defining the offset of dashes drawn at the borders of the arc segment, when the mouse hovers over it.
hoverBorderJoinStyleA character vector defining the arc border join style, when the mouse hovers over it. It can be either 'round', 'bevel', or 'miter'.
hoverBorderWidthA numeric scalar value defining the width of the each arc segment’s borders in pixels, when the mouse hovers over it.

See also: PolarAreaChart, Color, Fill

Source Code: PolarAreaData