Class: LineChart2D
An object in the Tree to display data imported from various source objects under “Solution” or from files.
It utilizes Ansys.Mechanical.DataModel.Utilities.Charts.Chart for displaying the imported data and provides users with the flexibility to modify the data to some extent
(eg. deleting, hiding/showing, modifying their display and applying operations on them).
Examples
Methods
| Name |
Description |
|
Activate()
|
Activate the current object.
|
|
CopyTo(DataModelObject)
|
Copies all visible properties from this object to another.
|
|
CreateParameter(String)
|
Creates a new parameter for a Property.
|
|
Duplicate()
|
Creates a copy of the current DataModelObject.
|
|
GetIndependentVariable()
|
Returns the Dataset2D object chosen as the Independent Variable of the Chart.
|
|
GetParameter(String)
|
Gets the parameter corresponding to the given property.
|
|
GetPath()
|
Gets the path of the object.
|
|
GroupAllSimilarChildren()
|
Run the GroupAllSimilarChildren action.
|
|
GroupSimilarObjects()
|
Run the GroupSimilarObjects action.
|
|
PropertyByAPIName(String)
|
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.
|
|
PropertyByName(String)
|
Get a property by its unique name.
|
|
RemoveParameter(String)
|
Removes the parameter from the parameter set corresponding to the given property.
|
|
SetIndependentVariable(Dataset2D)
|
Sets the Dataset2D object chosen as the Independent Variable of the Chart.
Chart data are constructed using the chosen Dataset2D's Y-values as the Independent Variable and
the Y-values from the other datasets as the Dependent Variable. Only Y-values at intersecting X-values from the datasets are picked;
no interpolation is performed for missing X-values.
An input of "None" returns the chart to its original state.
If any dataset contains negative values that conflict with the Logarithmic setting of a chart axis, then Logarithmic for that axis is disabled.
An InvalidOperationException is thrown if any Dataset on the Chart is not strictly monotonic.
An ArgumentException is thrown if the chosen Independent Variable is not a Dataset on the Chart.
|
|
Update()
|
Fetches the latest results from the modified Source object(s)
and replaces the Datasets originally imported from the respective Source(s).
If any dataset contains negative values that conflict with the Logarithmic setting of a chart axis, then Logarithmic for that axis is disabled.
If the revised datasets from the Update operation conflict with the existing X-axis quantity on the chart,
the Update operation is aborted with an InvalidOperationException and the old data is restored.
|
Properties
| Name |
Description |
|
Chart
|
Gets the chart object on Line Chart.
|
|
Charts
|
Gets a list of all charts on the object.
|
|
DataModelObjectCategory
|
Gets the name of the current DataModelObject's category.
|
|
InternalObject
|
Gets the internal object. For advanced usage only.
|
|
Name
|
Gets the name of the object.
|
|
ObjectId
|
Gets the internal id of the object.
|
|
ObjectTags
|
Gets an IEnumerable object of the tags that 'this' is a part of.
|
|
Parent
|
Gets the parent object.
|
|
Properties
|
Gets the list of properties for this object.
|
|
Source
|
Gets or sets source objects.
When setting, all datasets are copied from the specified sources and added to the chart object owned by LineChart2D.
We will ignore unsupported objects and import the ones that are supported.
|
|
Suppressed
|
Gets or sets the Suppressed.
|
|
VisibleProperties
|
Gets the list of properties that are visible for this object.
|