Categories &

Functions List

Class Definition: PolarAreaData

chartjs: PolarAreaData

One dataset of a polar area chart.

A PolarAreaChart holds a PolarAreaData object for each of its datasets, whose properties set how Chart.js draws it.

Each property is documented on its own, as in help PolarAreaData.data.

See also: PolarAreaChart, Color, Fill

Source Code: PolarAreaData

The PolarAreaData class contains the following properties:

A 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.

A 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.

A 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.

A numeric vector defining the length and spacing of dashes drawn at the borders of the arc segments.

A numeric scalar defining the offset of dashes drawn at the borders of the arc segments. Default is 0.

A character vector defining the arc border join style. It can be either 'round', 'bevel', or 'miter'.

A numeric scalar value defining the width of the each arc segment’s borders in pixels. Default is 2.

A boolean scalar value defining whether the arc will be curved or flat. By default, it is true corresponding to curved arc segments.

A 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.

A numeric vector assigned at construction of the PolarAreaData object. It cannot be empty.

A 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.

A 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.

A numeric vector defining the length and spacing of dashes drawn at the borders of the arc segment, when the mouse hovers over it.

A numeric scalar defining the offset of dashes drawn at the borders of the arc segment, when the mouse hovers over it.

A character vector defining the arc border join style, when the mouse hovers over it. It can be either 'round', 'bevel', or 'miter'.

A numeric scalar value defining the width of the each arc segment’s borders in pixels, when the mouse hovers over it.

The PolarAreaData class offers the following public methods:

PolarAreaData: obj = PolarAreaData (data)

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.

PolarAreaData: json = jsonstring (obj)

jsonstring (obj) returns a character vector, json, holding the dataset in JSON, as Chart.js reads it in the datasets of a chart.