WAPlotSettings Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|WAPlots Class|WAPlots}}
{{Template:API}}{{Template:APIBreadcrumb}}
Specifies various plot settings that will be used when a plot is created.


In Weibull++/ALTA, most of these settings are accessible from the Show/Hide Plot Items window and the plot sheet's control panel.
 
Represents the plot settings of an associated [[WAPlots Class|WAPlots]] object.


== Properties==
== Properties==
 
{| {{APITable}}
'''Confidence Bounds'''
|-
*ConfBounds_SideSelected (as ''[[ConfBoundsSides Enumeration|ConfBoundsSides]]'') {{APIComment|Sides of the confidence bounds.}}
| style="width: 180px;"|
*ConfBounds_TypesSelected (as ''[[ConfBoundsTypes Enumeration|ConfBoundsTypes]]'') {{APIComment|Type of the confidence bounds.}}
|-
*ConfidenceLevel (as ''double'') {{APIComment|Confidence level.}}
|ConfBounds_SideSelected||Gets or sets a value from the '''[[ConfBoundsSides_Enumeration|ConfBoundsSides]]''' enumeration, which specifies the sides of the confidence bounds (e.g., two-sided bounds, one-sided upper bound, etc.)
*ContourConfLevel (as ''double'') {{APIComment|Confidence level for contour line plot.}}
|-
 
|ConfBounds_TypesSelected||Gets or sets a value from the '''[[ConfBoundsTypes_Enumeration|ConfBoundsTypes]]''' enumeration, which specifies the type of the confidence bounds (e.g., type I or type II, etc.)
'''Target Reliability'''
|-
*ShowTargetReliability (as ''boolean'') {{APIComment|Whether to show the target reliability line.}}
|ConfidenceLevel||Gets or sets the confidence level. '''Double'''
*TargetReliability (as ''double'') {{APIComment|The value of target reliability.}}
|-
*ShowTargetTime (as ''boolean'') {{APIComment|Whether to show the target time line.}}
|ContourConfLevel||Gets or sets the confidence level for the contour line plot. '''Double'''
*TargetTime (as ''double'') {{APIComment|The value of target time.}}
|-
*ShowTargetMarker (as ''boolean'') {{APIComment|Whether to show the a marker on the intersection of the target reliability and time lines.}}
|ShowTargetReliability||Indicates whether to show the target reliability line on the plot. '''Boolean'''.
 
|-
'''Scaling'''
|TargetReliability||Gets or sets the value of the target reliability. '''Double'''
*AutoscaleX (as ''boolean'') {{APIComment|Whether the X-scale is calculated automatically.}}
|-
*AutoscaleY (as ''boolean'') {{APIComment|Whether the Y-scale is calculated automatically.}}
|ShowTargetTime||Indicates whether to show the target time line on the plot. '''Boolean'''
*Xmax (as ''double'') {{APIComment|X-scale end. Only used if AutoscaleX is false.}}
|-
*Xmin (as ''double'') {{APIComment|X-scale start. Only used if AutoscaleX is false.}}
|TargetTime||Gets or sets the value of the target time. '''Double'''
*Ymax (as ''double'') {{APIComment|Y-scale end. Only used if AutoscaleY is false.}}
|-
*Ymin (as ''double'') {{APIComment|Y-scale start. Only used if AutoscaleY is false.}}
|ShowTargetMarker||Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. '''Boolean'''
 
|-
'''Show/Hide Items'''
|AutoscaleX||Indicates whether the plot automatically chooses the appropriate values for the X-axis. '''Boolean'''
*ShowLeftCensoredPoints (as ''boolean'') {{APIComment|Whether to show left censored points on X-axis.}}
|-
*ShowLinesAroundInterval (as ''boolean'') {{APIComment|Whether to show vertical lines around an interval line.}}
|AutoscaleY||Indicates whether the plot automatically chooses the appropriate values for the Y-axis. '''Boolean'''
*ShowNumberInGroup (as ''boolean'') {{APIComment|Whether to show the number of points in the group for grouped data.}}
|-
*ShowParameterBar (as ''boolean'') {{APIComment|Whether to show the parameter bars as probability plot.}}
|Xmax||Gets or sets the maximum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''
*ShowParameterScales (as ''boolean'') {{APIComment|Whether to show the parameter scales as probability plot.}}
|-Xmin||Gets or sets the minimum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''
*ShowSuspensionPoints (as ''boolean'') {{APIComment|Whether to show suspension points on X-axis.}}
|-
 
|Ymax||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
'''Axis Labels'''
|-
*PlotXPrecision (as ''integer'') {{APIComment|Precision for labels on X-axis.}}
|Ymin||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
*PlotXTolerance (as ''integer'') {{APIComment|Tolerance for labels on X-axis.}}
|-
*PlotYPrecision (as ''integer'') {{APIComment|Precision for labels on Y-axis.}}
|ShowLeftCensoredPoints||Indicates whether to show the left censored points on the plot when plotting interval or left censored data. '''Boolean'''
*PlotYTolerance (as ''integer'') {{APIComment|Tlerance for labels on Y-axis.}}
|-
 
|ShowLinesAroundInterval||Indicates whether to show vertical lines around the points for interval censored data. '''Boolean'''
'''Failures/Suspensions Histogram Setting
|-
*HistogramInterval (as ''double'') {{APIComment|Interval in histogram plots. Set it to 0 to use the automatically calculated interval.}}
|ShowNumberInGroup||Indicates whether to show the number of data points in the group for grouped data. '''Boolean'''
 
|-
'''Plot Legend'''
|ShowParameterBar||Indicates whether to show a box around the parameter scales on a probability plot. '''Boolean'''
*UserCompany (as ''string'') {{APIComment|Company name that appears on the plot.}}
|-
*UserName (as ''string'') {{APIComment|User name that appears on the plot.}}
|ShowParameterScales||Indicates whether to show the parameter scales on a probability plot. '''Boolean'''
 
|-
'''Other Options'''
|ShowSuspensionPoints||Indicates whether to show the suspension (right-censored) data points on the plot when plotting suspended data. '''Boolean'''
*AdjustMLEPoints (as ''boolean'') {{APIComment|Whether to adjust MLE points.}}
|-
*StraightenGammaLine (as ''boolean'') {{APIComment|Whether to streighten the probability line for Gamma and G-Gamma distributions.}}
|PlotXPrecision||Gets or sets the math precision of the labels on the X-axis. '''Integer'''
|-
|PlotXTolerance||Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. '''Integer'''
|-
|PlotYPrecision||Gets or sets the math precision of the labels on the Y-axis. '''Integer'''
|-
|PlotYTolerance||Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. '''Integer'''
|-
|HistogramInterval||Gets or sets the interval in histogram plots. Set it to 0 to use the automatically calculated interval. '''Double'''
|-
|UserCompany||Gets or sets the company name that appears on the plot. '''String'''
|-
|UserName||Gets or sets the user name that appears on the plot. '''String'''
|-
|AdjustMLEPoints||Indicates whether to adjust the y-axis positions of the plotted points to fit the MLE solution line (instead of plotting the points from rank regression). '''Boolean'''
|-
|StraightenGammaLine||Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. '''Boolean'''
|}


=Usage Example=
=Usage Example=

Revision as of 18:29, 20 April 2016

APIWiki.png


Member of: SynthesisAPI


Represents the plot settings of an associated WAPlots object.

Properties

Name Description
ConfBounds_SideSelected Gets or sets a value from the ConfBoundsSides enumeration, which specifies the sides of the confidence bounds (e.g., two-sided bounds, one-sided upper bound, etc.)
ConfBounds_TypesSelected Gets or sets a value from the ConfBoundsTypes enumeration, which specifies the type of the confidence bounds (e.g., type I or type II, etc.)
ConfidenceLevel Gets or sets the confidence level. Double
ContourConfLevel Gets or sets the confidence level for the contour line plot. Double
ShowTargetReliability Indicates whether to show the target reliability line on the plot. Boolean.
TargetReliability Gets or sets the value of the target reliability. Double
ShowTargetTime Indicates whether to show the target time line on the plot. Boolean
TargetTime Gets or sets the value of the target time. Double
ShowTargetMarker Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. Boolean
AutoscaleX Indicates whether the plot automatically chooses the appropriate values for the X-axis. Boolean
AutoscaleY Indicates whether the plot automatically chooses the appropriate values for the Y-axis. Boolean
Xmax Gets or sets the maximum value for the X-axis. Applies only if AutoscaleX is false. Double
Ymax Gets or sets the maximum value for the Y-axis. Applies only if AutoscaleY is false. Double
Ymin Gets or sets the maximum value for the Y-axis. Applies only if AutoscaleY is false. Double
ShowLeftCensoredPoints Indicates whether to show the left censored points on the plot when plotting interval or left censored data. Boolean
ShowLinesAroundInterval Indicates whether to show vertical lines around the points for interval censored data. Boolean
ShowNumberInGroup Indicates whether to show the number of data points in the group for grouped data. Boolean
ShowParameterBar Indicates whether to show a box around the parameter scales on a probability plot. Boolean
ShowParameterScales Indicates whether to show the parameter scales on a probability plot. Boolean
ShowSuspensionPoints Indicates whether to show the suspension (right-censored) data points on the plot when plotting suspended data. Boolean
PlotXPrecision Gets or sets the math precision of the labels on the X-axis. Integer
PlotXTolerance Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. Integer
PlotYPrecision Gets or sets the math precision of the labels on the Y-axis. Integer
PlotYTolerance Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. Integer
HistogramInterval Gets or sets the interval in histogram plots. Set it to 0 to use the automatically calculated interval. Double
UserCompany Gets or sets the company name that appears on the plot. String
UserName Gets or sets the user name that appears on the plot. String
AdjustMLEPoints Indicates whether to adjust the y-axis positions of the plotted points to fit the MLE solution line (instead of plotting the points from rank regression). Boolean
StraightenGammaLine Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. Boolean

Usage Example

 'Create a new WAPlotSettings object. 
 Dim NewPlotSettings As New WAPlotSettings
 
 'Set the plot settings. 
 NewPlotSettings.UserName = ""
 NewPlotSettings.UserCompany = ""
 NewPlotSettings.AutoscaleX = True
 NewPlotSettings.AutoscaleY = True
 NewPlotSettings.Xmin = 0
 NewPlotSettings.Xmax = 0
 NewPlotSettings.Ymin = 0
 NewPlotSettings.ymax = 0
 NewPlotSettings.ShowParameterBar = True
 NewPlotSettings.ShowParameterScales = True
 NewPlotSettings.ShowTargetReliability = True
 NewPlotSettings.ShowTargetTime = True
 NewPlotSettings.ShowTargetMarker = True
 NewPlotSettings.TargetReliability = 0
 NewPlotSettings.TargetTime = 0
 NewPlotSettings.ShowSuspensionPoints = True
 NewPlotSettings.ShowLeftCensoredPoints = True
 NewPlotSettings.ShowLinesAroundInterval = True
 NewPlotSettings.AdjustMLEPoints = True
 NewPlotSettings.StraightenGammaLine = True
 NewPlotSettings.ShowNumberInGroup = True
 NewPlotSettings.PlotXPrecision = 0
 NewPlotSettings.PlotyPrecision = 0
 NewPlotSettings.PlotXTolerance = 0
 NewPlotSettings.PlotYTolerance = 0
 NewPlotSettings.ConfBounds_SideSelected = ConfBoundsSides.TwoSidedBoth
 NewPlotSettings.ConfBounds_TypesSelected = ConfBoundsTypes.None
 NewPlotSettings.ConfidenceLevel = 0
 NewPlotSettings.ContourConfLevel = 0
 NewPlotSettings.HistogramInterval = 0
Retrieved from "https://www.reliawiki.com/index.php?title=WAPlotSettings_Class&oldid=63452"