AccelerationWaterfallDiagram#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.AccelerationWaterfallDiagram(internalObject: Any)#

Bases: object

Defines a AccelerationWaterfallDiagram.

Overview#

Activate

Activate the current object.

AddAlert

Creates a new Alert

AddComment

Creates a new child Comment.

AddConvergence

Creates a new Convergence

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

BodyWhereMaximumOccurs

Gets the body that has the maximum result value.

ClearGeneratedData

Run the ClearGeneratedData action.

CopyTo

Copies all visible properties from this object to another.

CreateObjRef

CreateObjRef method.

CreateParameter

CreateParameter method.

CreateResultsAtAllSets

Creates results at all sets for results under a solution.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

DuplicateWithoutResults

Run the DuplicateWithoutResults action.

Equals

Equals method.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

ExportToSTLFile

ExportToSTLFile method.

ExportToTextFile

ExportToTextFile method.

FetchRemoteResult

Run the FetchRemoteResult action.

FetchRemoteResults

Run the FetchRemoteResult action.

GetAPIName

GetAPIName method.

GetAllProperties

GetAllProperties method.

GetChildren

Gets the list of children, filtered by type.

GetDetailsView

GetDetailsView method.

GetEnumName

Enum name bound to value

GetHashCode

GetHashCode method.

GetIconFile

GetIconFile method.

GetLifetimeService

GetLifetimeService method.

GetNodalValues

GetNodalValues method.

GetObjectData

GetObjectData method.

GetParameter

Gets the parameter corresponding to the given property.

GetPath

GetPath method.

GetPropertyName

GetPropertyName method.

GetPropertyValue

GetPropertyValue method.

GetQuantityName

GetQuantityName method.

GetType

GetType method.

GetVisibleProperties

GetVisibleProperties method.

GetVisiblePropertyNames

GetVisiblePropertyNames method.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

InitializeLifetimeService

InitializeLifetimeService method.

IsPropertyEditable

IsPropertyEditable method.

IsPropertyVisible

IsPropertyVisible method.

PromoteToNamedSelection

Run the PromoteToNamedSelection action.

PropertyByAPIName

Get a property by its API name.

PropertyById

PropertyById method.

PropertyByName

Get a property by its unique name.

RemoveParameter

Removes the parameter from the parameter set corresponding to the given property.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

RetrieveRemoteDPFResults

RetrieveRemoteDPFResults method.

RetrieveResult

Evaluates the individual result without evaluating all the results in the same solution.

ToString

ToString method.

AttachedRefs

AttachedRefs property.

Average

Gets the Average.

By

Gets or sets the By.

CalculateTimeHistory

Gets or sets the CalculateTimeHistory.

Children

Gets the list of children.

ClsId

ClsId property.

CombinationNumber

Gets or sets the Combination Number for a Solution Combination result.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the Coordinate System.

CrackFrontNumber

Gets or sets the CrackFrontNumber.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayOption

Gets or sets the DisplayOption.

DisplayOrder

Gets or sets the DisplayOrder.

DisplayPanel

Gets or sets the DisplayPanel.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

Figures

Gets the list of associated figures.

FrequencySelection

Gets or sets the FrequencySelection.

GlobalIDs

Gets or sets the GlobalIDs.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Identifier

Gets or sets the Identifier.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

ItemType

Gets or sets the ItemType.

IterationNumber

Gets the IterationNumber.

LoadStep

Gets the LoadStep.

LoadStepForMaximumOfMaximumValues

Get the Load Step for the maximum of maximum values.

LoadStepForMaximumOfMinimumValues

Get the Load Step for the maximum of minimum values.

LoadStepForMinimumOfMaximumValues

Get the Load Step for the minimum of maximum values.

LoadStepForMinimumOfMinimumValues

Get the Load Step for the minimum of minimum values.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

Maximum

Gets the Maximum.

MaximumOccursOn

Gets the MaximumOccursOn.

MaximumOfMaximumOverTime

Gets the MaximumOfMaximumOverTime.

MaximumOfMinimumOverTime

Gets the MaximumOfMinimumOverTime.

Minimum

Gets the Minimum.

MinimumOccursOn

Gets the MinimumOccursOn.

MinimumOfMaximumOverTime

Gets the MinimumOfMaximumOverTime.

MinimumOfMinimumOverTime

Gets the MinimumOfMinimumOverTime.

MosaicChartLegendMax

Gets or sets the MosaicChartLegendMax.

MosaicChartLegendMin

Gets or sets the MosaicChartLegendMin.

Name

Name property.

NamedSelections

Gets or sets the NamedSelections.

NormalOrientation

Gets or sets the NormalOrientation.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

OrderSelection

Gets or sets the OrderSelection.

OrdersToDisplay

Gets or sets the OrdersToDisplay.

PanelContribution

Gets or sets the PanelContribution.

PanelsToDisplay

Gets or sets the PanelsToDisplay.

Parent

Parent property.

Path

Path property.

PlotData

Gets the result table.

Properties

Gets the list of properties for this object.

RPMSelection

Gets or sets the RPM Selection value at which the results are evaluated.

ResultType

Gets or sets the ResultType.

RpmSelection

Gets or sets the RpmSelection.

RpmSelectionUnit

Gets the RpmSelectionUnit.

RpmSetNumber

Gets or sets the RpmSetNumber.

STFTCutoffFrequency

Gets or sets the STFTCutoffFrequency.

STFTEndTime

Gets or sets the STFTEndTime.

STFTMinFreqResolution

Gets or sets the STFTMinFreqResolution.

STFTNumberSlice

Gets or sets the STFTNumberSlice.

STFTOverlap

Gets or sets the STFTOverlap.

STFTStartTime

Gets or sets the STFTStartTime.

STFTWindowType

Gets or sets the STFTWindowType.

ScopingMethod

Gets or sets the ScopingMethod.

SeparateDataByEntity

Gets or sets the SeparateDataByEntity.

SetNumber

Gets or sets the Set Number.

ShowTextOnMosaic

Gets or sets the ShowTextOnMosaic.

SolutionCombinationDriver

Gets or sets the SolutionCombinationDriver.

SolverComponentIDs

Gets or sets the SolverComponentIDs.

SpatialResolution

Gets or sets the SpatialResolution.

State

State property.

Substep

Gets the Substep.

Suppressed

Gets or sets the Suppressed.

Surface

Surface property.

SurfaceCoating

SurfaceCoating property.

TabularData

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

Time

Gets the Time.

TimeForMaximumOfMaximumValues

Get the Time for the maximum of maximum values.

TimeForMaximumOfMinimumValues

Get the Time for the maximum of minimum values.

TimeForMinimumOfMaximumValues

Get the Time for the minimum of maximum values.

TimeForMinimumOfMinimumValues

Get the Time for the minimum of minimum values.

Total

Gets the Total.

UseModeContribution

Gets or sets the UseModeContribution.

UsePanelContribution

Gets or sets the UsePanelContribution.

VisibleProperties

Gets the list of properties that are visible for this object.

WaterfallDisplayFilterBy

Gets or sets the Filer in Waterfall.

WaterfallDisplayFrequencySelection

Gets or sets the Frequency Selection.

WaterfallDisplayInterpolateData

Gets or sets the Interpolate Data Property.

WaterfallDisplayLowerBand

Gets or sets the Lower Band Value.

WaterfallDisplayMaxRPM

Gets or sets the Display Max RPM.

WaterfallDisplayMinRPM

Gets or sets the Display Min RPM.

WaterfallDisplayModeSelection

Gets or sets the Mode Selection.

WaterfallDisplayOrderSelection

Gets or sets the Order Selection.

WaterfallDisplayRpmSelection

Gets or sets the RPM Selection.

WaterfallDisplayScopeToOrderLines

Gets or sets the Scope to Order Lines Property.

WaterfallDisplayTimeSelection

Gets or sets the Time Selection.

WaterfallDisplayUpperBand

Gets or sets the Upper Band Value.

WaterfallDisplayXAxisMaximum

Gets or sets the Maximum X-Axis Value.

WaterfallDisplayXAxisMinimum

Gets or sets the Minimum X-Axis Value.

WaterfallDisplayYAxisMaximum

Gets or sets the Maximum Y-Axis Value.

WaterfallDisplayYAxisMinimum

Gets or sets the Minimum Y-Axis Value.

WaterfallShowTextOnMosaic

Gets or sets the Waterfall Mosaic Text Property.

Property detail#

property AccelerationWaterfallDiagram.AttachedRefs: List[int] | None#

AttachedRefs property.

property AccelerationWaterfallDiagram.Average: Ansys.Core.Units.Quantity | None#

Gets the Average.

property AccelerationWaterfallDiagram.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#

Gets or sets the By.

property AccelerationWaterfallDiagram.CalculateTimeHistory: bool | None#

Gets or sets the CalculateTimeHistory.

property AccelerationWaterfallDiagram.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property AccelerationWaterfallDiagram.ClsId: int | None#

ClsId property.

property AccelerationWaterfallDiagram.CombinationNumber: int | None#

Gets or sets the Combination Number for a Solution Combination result.

property AccelerationWaterfallDiagram.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#

Gets the list of associated comments.

property AccelerationWaterfallDiagram.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

property AccelerationWaterfallDiagram.CrackFrontNumber: int | None#

Gets or sets the CrackFrontNumber.

property AccelerationWaterfallDiagram.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property AccelerationWaterfallDiagram.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None#

Gets or sets the DisplayOption.

property AccelerationWaterfallDiagram.DisplayOrder: bool | None#

Gets or sets the DisplayOrder.

property AccelerationWaterfallDiagram.DisplayPanel: bool | None#

Gets or sets the DisplayPanel.

property AccelerationWaterfallDiagram.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property AccelerationWaterfallDiagram.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

property AccelerationWaterfallDiagram.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property AccelerationWaterfallDiagram.FrequencySelection: str | None#

Gets or sets the FrequencySelection.

property AccelerationWaterfallDiagram.GlobalIDs: str | None#

Gets or sets the GlobalIDs.

property AccelerationWaterfallDiagram.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#

Gets or sets the GraphControlsXAxis.

property AccelerationWaterfallDiagram.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property AccelerationWaterfallDiagram.IconName: str | None#

IconName property.

property AccelerationWaterfallDiagram.Identifier: str | None#

Gets or sets the Identifier.

property AccelerationWaterfallDiagram.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#

Gets the list of associated images.

property AccelerationWaterfallDiagram.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None#

Gets the internal object. For advanced usage only.

property AccelerationWaterfallDiagram.IsSolved: bool | None#

Gets the IsSolved.

property AccelerationWaterfallDiagram.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#

Gets or sets the ItemType.

property AccelerationWaterfallDiagram.IterationNumber: int | None#

Gets the IterationNumber.

property AccelerationWaterfallDiagram.LoadStep: int | None#

Gets the LoadStep.

property AccelerationWaterfallDiagram.LoadStepForMaximumOfMaximumValues: int | None#

Get the Load Step for the maximum of maximum values.

property AccelerationWaterfallDiagram.LoadStepForMaximumOfMinimumValues: int | None#

Get the Load Step for the maximum of minimum values.

property AccelerationWaterfallDiagram.LoadStepForMinimumOfMaximumValues: int | None#

Get the Load Step for the minimum of maximum values.

property AccelerationWaterfallDiagram.LoadStepForMinimumOfMinimumValues: int | None#

Get the Load Step for the minimum of minimum values.

property AccelerationWaterfallDiagram.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property AccelerationWaterfallDiagram.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property AccelerationWaterfallDiagram.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property AccelerationWaterfallDiagram.MaximumOccursOn: str | None#

Gets the MaximumOccursOn.

property AccelerationWaterfallDiagram.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMaximumOverTime.

property AccelerationWaterfallDiagram.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMinimumOverTime.

property AccelerationWaterfallDiagram.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property AccelerationWaterfallDiagram.MinimumOccursOn: str | None#

Gets the MinimumOccursOn.

property AccelerationWaterfallDiagram.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMaximumOverTime.

property AccelerationWaterfallDiagram.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMinimumOverTime.

property AccelerationWaterfallDiagram.MosaicChartLegendMax: float | None#

Gets or sets the MosaicChartLegendMax.

property AccelerationWaterfallDiagram.MosaicChartLegendMin: float | None#

Gets or sets the MosaicChartLegendMin.

property AccelerationWaterfallDiagram.Name: str | None#

Name property.

property AccelerationWaterfallDiagram.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets or sets the NamedSelections.

property AccelerationWaterfallDiagram.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None#

Gets or sets the NormalOrientation.

property AccelerationWaterfallDiagram.ObjectId: int | None#

ObjectId property.

property AccelerationWaterfallDiagram.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

property AccelerationWaterfallDiagram.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#

ObjectTags property.

property AccelerationWaterfallDiagram.OrderSelection: str | None#

Gets or sets the OrderSelection.

property AccelerationWaterfallDiagram.OrdersToDisplay: int | None#

Gets or sets the OrdersToDisplay.

property AccelerationWaterfallDiagram.PanelContribution: bool | None#

Gets or sets the PanelContribution.

property AccelerationWaterfallDiagram.PanelsToDisplay: int | None#

Gets or sets the PanelsToDisplay.

property AccelerationWaterfallDiagram.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

property AccelerationWaterfallDiagram.Path: Ansys.ACT.Automation.Mechanical.Path | None#

Path property.

property AccelerationWaterfallDiagram.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None#

Gets the result table.

property AccelerationWaterfallDiagram.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property AccelerationWaterfallDiagram.RPMSelection: Ansys.Core.Units.Quantity | None#

Gets or sets the RPM Selection value at which the results are evaluated.

property AccelerationWaterfallDiagram.ResultType: Ansys.Mechanical.DataModel.Enums.ResultType | None#

Gets or sets the ResultType.

property AccelerationWaterfallDiagram.RpmSelection: str | None#

Gets or sets the RpmSelection.

property AccelerationWaterfallDiagram.RpmSelectionUnit: str | None#

Gets the RpmSelectionUnit.

property AccelerationWaterfallDiagram.RpmSetNumber: int | None#

Gets or sets the RpmSetNumber.

property AccelerationWaterfallDiagram.STFTCutoffFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the STFTCutoffFrequency.

property AccelerationWaterfallDiagram.STFTEndTime: Ansys.Core.Units.Quantity | None#

Gets or sets the STFTEndTime.

property AccelerationWaterfallDiagram.STFTMinFreqResolution: Ansys.Core.Units.Quantity | None#

Gets or sets the STFTMinFreqResolution.

property AccelerationWaterfallDiagram.STFTNumberSlice: int | None#

Gets or sets the STFTNumberSlice.

property AccelerationWaterfallDiagram.STFTOverlap: float | None#

Gets or sets the STFTOverlap.

property AccelerationWaterfallDiagram.STFTStartTime: Ansys.Core.Units.Quantity | None#

Gets or sets the STFTStartTime.

property AccelerationWaterfallDiagram.STFTWindowType: Ansys.Mechanical.DataModel.Enums.WindowType | None#

Gets or sets the STFTWindowType.

property AccelerationWaterfallDiagram.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property AccelerationWaterfallDiagram.SeparateDataByEntity: bool | None#

Gets or sets the SeparateDataByEntity.

property AccelerationWaterfallDiagram.SetNumber: int | None#

Gets or sets the Set Number.

property AccelerationWaterfallDiagram.ShowTextOnMosaic: Ansys.Mechanical.DataModel.Enums.ShowTextOnMosaicMode | None#

Gets or sets the ShowTextOnMosaic.

property AccelerationWaterfallDiagram.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None#

Gets or sets the SolutionCombinationDriver.

property AccelerationWaterfallDiagram.SolverComponentIDs: str | None#

Gets or sets the SolverComponentIDs.

property AccelerationWaterfallDiagram.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None#

Gets or sets the SpatialResolution.

property AccelerationWaterfallDiagram.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property AccelerationWaterfallDiagram.Substep: int | None#

Gets the Substep.

property AccelerationWaterfallDiagram.Suppressed: bool | None#

Gets or sets the Suppressed.

property AccelerationWaterfallDiagram.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#

Surface property.

property AccelerationWaterfallDiagram.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None#

SurfaceCoating property.

property AccelerationWaterfallDiagram.TabularData: Ansys.Mechanical.Interfaces.ITable | None#

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

property AccelerationWaterfallDiagram.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property AccelerationWaterfallDiagram.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of maximum values.

property AccelerationWaterfallDiagram.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of minimum values.

property AccelerationWaterfallDiagram.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of maximum values.

property AccelerationWaterfallDiagram.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of minimum values.

property AccelerationWaterfallDiagram.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property AccelerationWaterfallDiagram.UseModeContribution: bool | None#

Gets or sets the UseModeContribution.

property AccelerationWaterfallDiagram.UsePanelContribution: bool | None#

Gets or sets the UsePanelContribution.

property AccelerationWaterfallDiagram.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

property AccelerationWaterfallDiagram.WaterfallDisplayFilterBy: Ansys.Mechanical.DataModel.Enums.WaterfallDisplayFilterBy | None#

Gets or sets the Filer in Waterfall.

property AccelerationWaterfallDiagram.WaterfallDisplayFrequencySelection: str | None#

Gets or sets the Frequency Selection.

property AccelerationWaterfallDiagram.WaterfallDisplayInterpolateData: bool | None#

Gets or sets the Interpolate Data Property.

property AccelerationWaterfallDiagram.WaterfallDisplayLowerBand: float | None#

Gets or sets the Lower Band Value.

property AccelerationWaterfallDiagram.WaterfallDisplayMaxRPM: Ansys.Core.Units.Quantity | None#

Gets or sets the Display Max RPM.

property AccelerationWaterfallDiagram.WaterfallDisplayMinRPM: Ansys.Core.Units.Quantity | None#

Gets or sets the Display Min RPM.

property AccelerationWaterfallDiagram.WaterfallDisplayModeSelection: str | None#

Gets or sets the Mode Selection.

property AccelerationWaterfallDiagram.WaterfallDisplayOrderSelection: str | None#

Gets or sets the Order Selection.

property AccelerationWaterfallDiagram.WaterfallDisplayRpmSelection: str | None#

Gets or sets the RPM Selection.

property AccelerationWaterfallDiagram.WaterfallDisplayScopeToOrderLines: bool | None#

Gets or sets the Scope to Order Lines Property.

property AccelerationWaterfallDiagram.WaterfallDisplayTimeSelection: str | None#

Gets or sets the Time Selection.

property AccelerationWaterfallDiagram.WaterfallDisplayUpperBand: float | None#

Gets or sets the Upper Band Value.

property AccelerationWaterfallDiagram.WaterfallDisplayXAxisMaximum: float | None#

Gets or sets the Maximum X-Axis Value.

property AccelerationWaterfallDiagram.WaterfallDisplayXAxisMinimum: float | None#

Gets or sets the Minimum X-Axis Value.

property AccelerationWaterfallDiagram.WaterfallDisplayYAxisMaximum: float | None#

Gets or sets the Maximum Y-Axis Value.

property AccelerationWaterfallDiagram.WaterfallDisplayYAxisMinimum: float | None#

Gets or sets the Minimum Y-Axis Value.

property AccelerationWaterfallDiagram.WaterfallShowTextOnMosaic: bool | None#

Gets or sets the Waterfall Mosaic Text Property.

Method detail#

AccelerationWaterfallDiagram.Activate() None#

Activate the current object.

AccelerationWaterfallDiagram.AddAlert() Ansys.ACT.Automation.Mechanical.Results.Alert#

Creates a new Alert

AccelerationWaterfallDiagram.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

AccelerationWaterfallDiagram.AddConvergence() Ansys.ACT.Automation.Mechanical.Results.Convergence#

Creates a new Convergence

AccelerationWaterfallDiagram.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

AccelerationWaterfallDiagram.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image#
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.
AccelerationWaterfallDiagram.BodyWhereMaximumOccurs() Ansys.ACT.Automation.Mechanical.Body#
Gets the body that has the maximum result value.
Throws an exception if body not found.
AccelerationWaterfallDiagram.ClearGeneratedData() None#

Run the ClearGeneratedData action.

AccelerationWaterfallDiagram.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

AccelerationWaterfallDiagram.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

AccelerationWaterfallDiagram.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

CreateParameter method.

AccelerationWaterfallDiagram.CreateResultsAtAllSets() List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#

Creates results at all sets for results under a solution.

AccelerationWaterfallDiagram.Delete() None#

Run the Delete action.

AccelerationWaterfallDiagram.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

AccelerationWaterfallDiagram.DuplicateWithoutResults() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Run the DuplicateWithoutResults action.

AccelerationWaterfallDiagram.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

AccelerationWaterfallDiagram.EvaluateAllResults() None#

Run the EvaluateAllResults action.

AccelerationWaterfallDiagram.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#

Run the ExportAnimation action.

AccelerationWaterfallDiagram.ExportToSTLFile(filePath: str) None#

ExportToSTLFile method.

AccelerationWaterfallDiagram.ExportToTextFile(bIgnoreExcelPreference: bool, filePath: str) None#

ExportToTextFile method.

AccelerationWaterfallDiagram.FetchRemoteResult() None#

Run the FetchRemoteResult action.

AccelerationWaterfallDiagram.FetchRemoteResults() None#

Run the FetchRemoteResult action.

AccelerationWaterfallDiagram.GetAPIName(dispId: int) str#

GetAPIName method.

AccelerationWaterfallDiagram.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

AccelerationWaterfallDiagram.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

AccelerationWaterfallDiagram.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

AccelerationWaterfallDiagram.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

AccelerationWaterfallDiagram.GetHashCode() int#

GetHashCode method.

AccelerationWaterfallDiagram.GetIconFile() System.Byte#

GetIconFile method.

AccelerationWaterfallDiagram.GetLifetimeService() Any#

GetLifetimeService method.

AccelerationWaterfallDiagram.GetNodalValues(bodyRefId: int) System.Collections.Generic.Dictionary[int, float]#

GetNodalValues method.

AccelerationWaterfallDiagram.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

AccelerationWaterfallDiagram.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

AccelerationWaterfallDiagram.GetPath() str#

GetPath method.

AccelerationWaterfallDiagram.GetPropertyName(dispId: int) str#

GetPropertyName method.

AccelerationWaterfallDiagram.GetPropertyValue(name: str) Any#

GetPropertyValue method.

AccelerationWaterfallDiagram.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto) str#

GetQuantityName method.

AccelerationWaterfallDiagram.GetType() type#

GetType method.

AccelerationWaterfallDiagram.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

AccelerationWaterfallDiagram.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

AccelerationWaterfallDiagram.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

AccelerationWaterfallDiagram.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

AccelerationWaterfallDiagram.InitializeLifetimeService() Any#

InitializeLifetimeService method.

AccelerationWaterfallDiagram.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

AccelerationWaterfallDiagram.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

AccelerationWaterfallDiagram.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

AccelerationWaterfallDiagram.PropertyByAPIName(name: str) Ansys.ACT.Automation.Mechanical.Property#
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.
AccelerationWaterfallDiagram.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

AccelerationWaterfallDiagram.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

AccelerationWaterfallDiagram.RemoveParameter(propName: str) None#

Removes the parameter from the parameter set corresponding to the given property.

AccelerationWaterfallDiagram.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

AccelerationWaterfallDiagram.RetrieveRemoteDPFResults() None#

RetrieveRemoteDPFResults method.

AccelerationWaterfallDiagram.RetrieveResult() None#

Evaluates the individual result without evaluating all the results in the same solution.

AccelerationWaterfallDiagram.ToString() str#

ToString method.