`AxisDisplayOptions`#

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

A class that exposes methods/properties to customize the display of a chart axis.

Overview#

Methods

Copies the settings used in the input AxisDisplayOptions reference to the AxisDisplayOptions calling this method.

Properties

`AxisLabel`	Gets or sets the axis label.
`IsLogarithmic`	Gets or sets whether the axis is logarithmic.
`LowerLimit`	Gets the default lower limit of the axis range.
`MaximumLimit`	Gets or sets the Maximum limit used for the chart display.
`MinimumLimit`	Gets or sets the Minimum limit used for the chart display.
`ShowGridLines`	Gets or sets the visibility of the axis gridlines.
`UpperLimit`	Gets the default higher limit of the axis range.
`UseAutomaticLimits`	Gets or sets whether axis limits are automatic or user-defined.

property AxisDisplayOptions.AxisLabel: str | None#: Gets or sets the axis label.

property AxisDisplayOptions.IsLogarithmic: bool | None#: Gets or sets whether the axis is logarithmic. A NotSupportedException is thrown if a dataset contains a non-positive value on the chosen axis.

property AxisDisplayOptions.LowerLimit: Ansys.Core.Units.Quantity | None#: Gets the default lower limit of the axis range.

property AxisDisplayOptions.MaximumLimit: Ansys.Core.Units.Quantity | None#: Gets or sets the Maximum limit used for the chart display. If UseAutomaticLimits is True, a NotSupportedException is thrown on the setter.

property AxisDisplayOptions.MinimumLimit: Ansys.Core.Units.Quantity | None#: Gets or sets the Minimum limit used for the chart display. If UseAutomaticLimits is True, a NotSupportedException is thrown on the setter.

property AxisDisplayOptions.ShowGridLines: bool | None#: Gets or sets the visibility of the axis gridlines.

property AxisDisplayOptions.UpperLimit: Ansys.Core.Units.Quantity | None#: Gets the default higher limit of the axis range.

property AxisDisplayOptions.UseAutomaticLimits: bool | None#: Gets or sets whether axis limits are automatic or user-defined. When True, the MinimumLimit and MaximumLimit will be set to the LowerLimit and UpperLimit respectively.

AxisDisplayOptions.CopySettingsFrom(display_options_original: Ansys.Mechanical.DataModel.Utilities.Charts.AxisDisplayOptions) → None#: Copies the settings used in the input AxisDisplayOptions reference to the AxisDisplayOptions calling this method.