LabelCollection

A class to manage labels on the chart.

Declaration Syntax

public class LabelCollection

Table 70: Members

Property

Labels

Gets an IEnumerable of ILabelInfo objects, which contain information about the underlying label

Method

CreateAndAddLabel(Quantity, Quantity, string)

Creates a new label and adds it to the chart at a specified position, where the label_text parameter is optional. The default label text is: “x: <x_value>, y: <y_value>” (example: “x: 0.3497, y: 1.9821”). An InvalidOperationException will be thrown when creating a Label at a location already assigned to another Label.

Method

CreateLabelOnSegment(int, double)

Create a label on the segment of the dataset starting from the data point at a specified distance along the segment. Distance values are fractional going from 0 to 1 (first datapoint at 0) along the length of the segment An ArgumentException will be thrown when creating a Label at a location already assigned to another Label.

Method

CreateLabelsAtXCoordinate(Quantity)

Creates label(s) on the dataset at a specified X coordinate. This API may return multiple `LabelInfo` references in case the corresponding dataset has more than one Y-value for the given X-value (for eg. Spiral graphs). Each `LabelInfo` reference corresponds to the multiple anchor positions thus obtained. An ArgumentException will be thrown when creating a Label at a location already assigned to another Label.

Method

CreateLabelsAtYCoordinate(Quantity)

Creates label(s) on the dataset at a specified Y coordinate. This API may return multiple `LabelInfo` references in case the corresponding dataset has more than one X-value for a given Y-value. Each `LabelInfo` reference corresponds to the multiple anchor positions thus obtained. An ArgumentException will be thrown when creating a Label at a location already assigned to another Label.

Method

DeleteLabel(LabelInfo)

Deletes a label from a specific position in the chart. An InvalidOperationException will be thrown when deleting a Label that does not exist.

NestedType

LabelInfo

A class to reference a label and contain its information.