ErrorEstimate3DPlot
An error estimate 3D result.
Example
app = pf.GetApplication() app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Horn_error_estimates.fek]]) errorEstimateData = app.Models[1].Configurations[1].ErrorEstimates["ErrorEstimation1"] -- Add the error estimation to the 3D view errorEstimationPlot1 = app.Views[1].Plots:Add(errorEstimateData) -- SetProperties the quantity errorEstimationPlot1.Quantity.ValuesScaledToLog = true
Inheritance
The ErrorEstimate3DPlot object is derived from the Result3DPlot object.
Property List
- AxisNames
- The names of all the axes on the ResultPlot. (Read only List of string)
- DataSource
- The object that is the data source for this plot. (Read/Write ResultData)
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods. (Read only List of string)
- Label
- The object label. (Read/Write string)
- Legend
- The 3D plot legend properties. (Read only Plot3DLegendFormat)
- Quantity
- The error estimate 3D plot quantity properties. (Read only ErrorEstimatesQuantity)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the plot must be shown or hidden. (Read/Write boolean)
Method List
- Delete ()
- Delete the plot.
- GetAxisUnit (axis string)
- Returns the SI unit of the specified axis. (Returns a string object.)
- GetFixedAxisAvailableValues (axis string)
- Returns the list of available values for the specified fixed axis. (Returns a List of string object.)
- GetFixedAxisValue (axis string)
- Returns the current value for the specified fixed axis. (Returns a string object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetFixedAxisValue (axis string, numvalue number, unit string)
- Set the fixed axis to the specified value.
- SetFixedAxisValue (axis string, strvalue string)
- Set the fixed axis to the specified value.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Store ()
- Stores a copy of the plot. (Returns a Result3DPlot object.)
Property Details
- AxisNames
- The names of all the axes on the ResultPlot.
- Access
- Read only
- DataSource
- The object that is the data source for this plot.
- Type
- ResultData
- Access
- Read/Write
- FixedAxes
- The list of fixed axes for this plot. The fixed axes depend on the chosen PlotType as well as the contents of the ResultData object. The value for a specific fixed axis can be queried and set with the GetFixedAxisValue() and SetFixedAxisValue() methods.
- Access
- Read only
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Legend
- The 3D plot legend properties.
- Type
- Plot3DLegendFormat
- Access
- Read only
- Quantity
- The error estimate 3D plot quantity properties.
- Type
- ErrorEstimatesQuantity
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the plot must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
Method Details
- Delete ()
- Delete the plot.
- GetAxisUnit (axis string)
- Returns the SI unit of the specified axis.
- GetFixedAxisAvailableValues (axis string)
- Returns the list of available values for the specified fixed axis.
- GetFixedAxisValue (axis string)
- Returns the current value for the specified fixed axis.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A properties table.
- SetFixedAxisValue (axis string, numvalue number, unit string)
- Set the fixed axis to the specified value.
- SetFixedAxisValue (axis string, strvalue string)
- Set the fixed axis to the specified value.
- SetProperties (properties table)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(table)
- A table of properties defining the new state of the object.
- Store ()
- Stores a copy of the plot.
- Return
- Result3DPlot
- The new plot associated with the stored data.