Categories &

Functions List

Class Definition: DoughnutChart

chartjs: DoughnutChart

Doughnut chart drawn by the Chart.js library.

Each dataset of a DoughnutChart is a DoughnutData object in its datasets property.

To view the DoughnutChart object in your web browser, use its webserve () method. Alternatively, you can generate and/or save to a file the corresponding HTML code with the htmlstring () and htmlsave () methods and serve it online through a web server of your choice.

Each property is documented on its own, as in help DoughnutChart.labels.

See also: DoughnutData, Color, Fill, Html

Source Code: DoughnutChart

The DoughnutChart class contains the following properties:

A character vector defining the name of the Chart in the generated html code.

A cell array containing one or more DoughnutData objects corresponding to the data input.

A numeric vector or a cellstring array with the data labels defined in labels.

A cell array containing one or more Option and Plugin objects. Not used at the moment.

The DoughnutChart class offers the following public methods:

DoughnutChart: obj = DoughnutChart (data, labels)

DoughnutChart: obj = DoughnutChart (…, Name, Value)

obj = DoughnutChart (data, labels) returns a DoughnutChart object, in which data contains the proportional arc segments and labels contain the labels of each segment.

  • data must be a nonempty NxP numeric matrix, where each column corresponds to a separate dataset and each row corresponds to an element in labels. If data is a row vector and its length matches the number of elements in labels, then it is transposed to a column vector.
  • labels must be a nonempty numerical vector or cellstring array, where each element corresponds to a row in data. If labels is a character vector, then it is converted to a cellstring scalar.

obj = DoughnutChart (…, Name, Value) returns a DoughnutChart object with the properties of each dataset specified by one or more Name, Value pair arguments. Name can be any property name of a DoughnutData object and Value must correspond to the data type(s) and values accepted by that property. Type help DoughnutData for more details on the available properties.

Specifically for the properties that accept a Color object as their input value, besides the Color object you may also parse to the DoughnutChart constructor the same values accepted by the constructor of the Color object. However, if you choose to manually modify the DoughnutChart’s properties using the dot notation syntax, then you must assign a Color object to the chosen property. Type help Color for more details on the available syntax.

For properties that accept scalar values, you can pass a vector of the same type with each element corresponding to a different dataset. For properties that accept vectors, you can pass a matrix of the same type with each row corresponding to a different dataset. Otherwise, the same property value will be assigned to all datasets available in data. For properties accepting a character vector, you need to pass a cellstring array for multiple datasets, whereas for properties that can take mixed types of scalar values (i.e. either boolean and character vectors), you need to pass a cell array with each element corresponding to a different dataset.