`ReadOnlyChart`#

class ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Utilities.Charts.ReadOnlyChart#

Bases: object

ReadOnlyChart is used by objects to display data as a chart. The data itself is treated as read only and cannot be modified. Additional options are provided to customize the presentation of the data itself.

Overview#

Methods

`GetDisplayOptionsForDataset`	Returns a reference to the dataset display options for a specific dataset.
`GetLabelCollectionForDataset`	Returns a reference to the label collection for a specific dataset.

Properties

`Datasets`	Retrieves all datasets of a chart.
`NormalizeYAxis`	Allows a normalized display of y-axis values, usually for cases where the axis has mixed quantities.
`XAxisDisplayOptions`	Returns a reference to the x-axis display options of a chart.
`YAxisDisplayOptions`	Returns a reference to the y-axis display options of a chart.

Property detail#

property ReadOnlyChart.Datasets: List[Ansys.Mechanical.DataModel.Utilities.Dataset.Dataset2D] | None#: Retrieves all datasets of a chart.

property ReadOnlyChart.NormalizeYAxis: bool | None#: Allows a normalized display of y-axis values, usually for cases where the axis has mixed quantities. An InvalidOperationException will be thrown if attempting to set to False, when the Y axis datasets have incompatible Quantity types and the UseAutomaticLimits property is also set to False.

property ReadOnlyChart.XAxisDisplayOptions: Ansys.Mechanical.DataModel.Utilities.Charts.AxisDisplayOptions | None#: Returns a reference to the x-axis display options of a chart.

property ReadOnlyChart.YAxisDisplayOptions: Ansys.Mechanical.DataModel.Utilities.Charts.AxisDisplayOptions | None#: Returns a reference to the y-axis display options of a chart.

Method detail#

ReadOnlyChart.GetDisplayOptionsForDataset(dataset: Ansys.Mechanical.DataModel.Utilities.Dataset.Dataset2D) → Ansys.Mechanical.DataModel.Utilities.Charts.Dataset2DDisplayOptions#: Returns a reference to the dataset display options for a specific dataset.

ReadOnlyChart.GetLabelCollectionForDataset(dataset: Ansys.Mechanical.DataModel.Utilities.Dataset.Dataset2D) → Ansys.Mechanical.DataModel.Utilities.Charts.LabelCollection#: Returns a reference to the label collection for a specific dataset.