`Dataset2DDisplayOptions`

class Ansys.Mechanical.DataModel.Utilities.Charts.Dataset2DDisplayOptions

Bases: object

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

Overview

Methods

Name	Description
CopySettingsFrom	Copies the settings of a Dataset2DDisplayOptions reference to this Dataset2DDisplayOptions .

Properties

Name	Description
Color	Gets or sets the Dataset2D Color
IsVisible	Gets or sets the visibility of the Dataset2D
LineThickness	Gets or sets the Dataset2D line thickness (in pixels)
LineType	Gets or sets the Dataset2D Line display type
MarkerShape	Gets or sets the Dataset2D marker shape
MarkerSize	Gets or sets the Dataset2D marker size (in pixels)
Name	Gets or sets the Dataset2D name

Property detail

property Dataset2DDisplayOptions.Color : int | None

Gets or sets the Dataset2D Color

property Dataset2DDisplayOptions.IsVisible : bool | None

Gets or sets the visibility of the Dataset2D

property Dataset2DDisplayOptions.LineThickness : float | None

Gets or sets the Dataset2D line thickness (in pixels)

An ArgumentException is thrown for values less than 1.

property Dataset2DDisplayOptions.LineType : Ansys.Mechanical.DataModel.MechanicalEnums.Charts.Dataset2D.LineType | None

Gets or sets the Dataset2D Line display type

property Dataset2DDisplayOptions.MarkerShape : Ansys.Mechanical.DataModel.MechanicalEnums.Charts.Dataset2D.MarkerShape | None

Gets or sets the Dataset2D marker shape

property Dataset2DDisplayOptions.MarkerSize : float | None

Gets or sets the Dataset2D marker size (in pixels)

property Dataset2DDisplayOptions.Name : str | None

Gets or sets the Dataset2D name

Method detail

Dataset2DDisplayOptions.CopySettingsFrom(input_display_options: Ansys.Mechanical.DataModel.Utilities.Charts.Dataset2DDisplayOptions) → None

Copies the settings of a Dataset2DDisplayOptions reference to this Dataset2DDisplayOptions .