ChartDisplayOptions

class ansys.mechanical.stubs.v261.Ansys.Mechanical.DataModel.Utilities.Charts.ChartDisplayOptions

Bases: object

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

Overview

Methods

CopySettingsFrom

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

Properties

LegendPosition	Gets or sets the position of the legend. The default option is “ProgramControlled”.
ShowLegend	Gets or sets the visibility of the legend.
Title	Gets or sets the chart title.
TitleFontSize	Gets or sets the font size of the chart title.

Property detail

property ChartDisplayOptions.LegendPosition: Ansys.Mechanical.DataModel.MechanicalEnums.Charts.LegendPosition | None

Gets or sets the position of the legend. The default option is “ProgramControlled”.

property ChartDisplayOptions.ShowLegend: bool | None

Gets or sets the visibility of the legend.

property ChartDisplayOptions.Title: str | None

Gets or sets the chart title.

property ChartDisplayOptions.TitleFontSize: int | None

Gets or sets the font size of the chart title. An ArgumentException is thrown for values less than 1.

Method detail

ChartDisplayOptions.CopySettingsFrom(display_options_original: Ansys.Mechanical.DataModel.Utilities.Charts.ChartDisplayOptions) → None

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