`LabelCollection`#

class ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection#

Bases: object

A class to manage labels on the chart.

Overview#

Methods

`CreateAndAddLabel`	Creates a new label and adds it to the chart at a specified position, where the label_text parameter is optional.
`CreateLabelOnSegment`	Create a label on the segment of the dataset starting from the data point at a specified distance along the segment.
`CreateLabelsAtXCoordinate`	Creates label(s) on the dataset at a specified X coordinate.
`CreateLabelsAtYCoordinate`	Creates label(s) on the dataset at a specified Y coordinate.
`DeleteLabel`	Deletes a label from a specific position in the chart.
`Equals`	Equals method.
`GetHashCode`	GetHashCode method.
`GetType`	GetType method.
`ToString`	ToString method.

Properties

`InternalObject`	InternalObject property.
`Labels`	Gets an IEnumerable of ILabelInfo objects, which contain information about the underlying label

Property detail#

property LabelCollection.InternalObject: Ansys.Common.Interop.DSUtils.IDSChartLabelCollection | None#: InternalObject property.

property LabelCollection.Labels: Iterable[Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo] | None#: Gets an IEnumerable of ILabelInfo objects, which contain information about the underlying label

Method detail#

LabelCollection.CreateAndAddLabel(x_anchor: Ansys.Core.Units.Quantity, y_anchor: Ansys.Core.Units.Quantity, label_text: str) → Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo#

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: , y: ” (example: “x: 0.3497, y: 1.9821”).
An InvalidOperationException will be thrown when creating a Label at a location already assigned to another Label.

LabelCollection.CreateLabelOnSegment(data_point_index: int, fractional_distance: float) → Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo#

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.

LabelCollection.CreateLabelsAtXCoordinate(x_anchor: Ansys.Core.Units.Quantity) → List[Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo]#

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.

LabelCollection.CreateLabelsAtYCoordinate(y_anchor: Ansys.Core.Units.Quantity) → List[Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo]#

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.

LabelCollection.DeleteLabel(label: Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection.LabelInfo) → None#

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

LabelCollection.Equals(obj: Any) → bool#: Equals method.

LabelCollection.GetHashCode() → int#: GetHashCode method.

LabelCollection.GetType() → type#: GetType method.

LabelCollection.ToString() → str#: ToString method.