WAPlotSettings Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Plots|Global Plots}}
{{Template:API}}{{Template:APIBreadcrumb}}
 
 
Represents the plot settings of an associated [[WAPlots Class|WAPlots]] object.
 
== Constructor==
{| {{APITable}}
|-
| style="width: 180px;"|WAPlotSettings||Creates an instance of the WAPlotSettings class.
|}


{{Template:WAPlotSettings_Class.Cmt}} This should be used with [[WAPlots Class|WAPlots]].


== Properties==
== Properties==
{| {{APITable}}
|-
| style="width: 180px;"|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'''. Default value = False.
|-
|AutoscaleX||Indicates whether the plot automatically chooses the appropriate values for the X-axis. '''Boolean'''. Default value = True.
|-
|AutoscaleY||Indicates whether the plot automatically chooses the appropriate values for the Y-axis. '''Boolean'''. Default value = True.
|-
|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.). Default value = 0 (no bounds).
|-
|ConfBounds_TypesSelected||Gets or sets a value from the '''[[ConfBoundsTypes_Enumeration|ConfBoundsTypes]]''' enumeration, which specifies the type of confidence bounds (e.g., type I or type II, etc.). Default value = 0 (no bounds).
|-
|ConfidenceLevel||Gets or sets the confidence level. '''Double'''. Default value = 0.9
|-
|ContourConfLevel||Gets or sets the confidence level for the contour line plot. '''Double'''. Default value = 0.9
|-
|HistogramInterval||Gets or sets the interval in histogram plots. '''Double'''. Default value = 0 (interval is automatically calculated)
|-
|PlotXPrecision||Gets or sets the math precision of the labels on the X-axis. '''Integer'''. Default value = 6.
|-
|PlotXTolerance||Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. '''Integer'''. Default value = 6.
|-
|PlotYPrecision||Gets or sets the math precision of the labels on the Y-axis. '''Integer'''. Default value = 6.
|-
|PlotYTolerance||Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. '''Integer'''. Default value = 6.
|-
|Show3PWeibullAdjustedItems||Indicate whether to display the adjusted failure points, lines, and confidence bounds for 3-parameter Weibull probability plot. '''Boolean'''. Default value = True.
|-
|Show3PWeibullUnadjustedItems||Indicate whether to display the unadjusted failure points, lines, and confidence bounds for 3-parameter Weibull probability plot. '''Boolean'''. Default value = True.
|-
|ShowDataPoints||Indicates whether to show the data points on probability and reliability plots. '''Boolean'''. Default value = True.
|-
|ShowLeftCensoredPoints||Indicates whether to show the left censored points on the plot when plotting interval or left censored data. '''Boolean'''. Default value = False.
|-
|ShowLinesAroundInterval||Indicates whether to show vertical lines around the points for interval censored data. '''Boolean'''. Default value = True.
|-
|ShowNumberInGroup||Indicates whether to show the number of data points in the group for grouped data. '''Boolean'''. Default value = False.
|-
|ShowParameterBar||Indicates whether to show a box around the parameter scales on a probability plot. '''Boolean'''. Default value = False.
|-
|ShowParameterScales||Indicates whether to show the parameter scales on a probability plot. '''Boolean'''. Default value = False.
|-
|ShowSuspensionPoints||Indicates whether to show the suspension (right-censored) data points on the plot when plotting suspended data. '''Boolean'''. Default value = False.
|-
|ShowTargetMarker||Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. '''Boolean'''. Default value = False.
|-
|ShowTargetReliability||Indicates whether to show the target reliability line on the plot. '''Boolean'''. Default value = False.
|-
|ShowTargetTime||Indicates whether to show the target time line on the plot. '''Boolean'''. Default value = False.
|-
|StraightenGammaLine||Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. '''Boolean'''. Default value = True.
|-
|TargetReliability||Gets or sets the value of the target reliability. '''Double'''. Default value = 0.9
|-
|TargetTime||Gets or sets the value of the target time. '''Double'''. Default value = 100
|-
|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'''
|-
|Xmax||Gets or sets the maximum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''. Default value = 1.
|-
|Xmin||Gets or sets the minimum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''. Default value = 0.
|-
|Ymax||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''. Default value = 1.
|-
|Ymin||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''. Default value = 0.
|}


*'''[[WAPlotSettings.AdjustMLEPoints|AdjustMLEPoints]]''' {{APIComment|Whether to adjust MLE points.}}
==See Also==
*'''[[WAPlotSettings.AutoscaleX|AutoscaleX]]''' {{APIComment|Whether the X-scale is calculated automatically.}}
*[[WAPlots.CreatePlot|WAPlots.CreatePlot Method]] (.NET only)
*'''[[WAPlotSettings.AutoscaleY|AutoscaleY]]''' {{APIComment|Whether the Y-scale is calculated automatically.}}
*[[WAPlots.CreatePlotVB6|WAPlots.CreatePlotVB6 Method]] (VBA/VB6 only)
*'''[[WAPlotSettings.ConfBounds_SideSelected|ConfBounds_SideSelected]]''' {{APIComment|Sides of the confidence bounds.}}
<!---
*'''[[WAPlotSettings.ConfBounds_TypesSelected|ConfBounds_TypesSelected]]''' {{APIComment|Type of the confidence bounds.}}
=Usage Example=
*'''[[WAPlotSettings.ConfidenceLevel|ConfidenceLevel]]''' {{APIComment|Confidence level.}}
{{APIComment|'Create a new WAPlotSettings object.}}
*'''[[WAPlotSettings.ContourConfLevel|ContourConfLevel]]''' {{APIComment|Confidence level for contour line plot.}}
  Dim NewPlotSettings As New WAPlotSettings
*'''[[WAPlotSettings.HistogramInterval|HistogramInterval]]''' {{APIComment|Interval in histogram plots. Set it to 0 to use the automatically calculated interval.}}
 
*'''[[WAPlotSettings.PlotXPrecision|PlotXPrecision]]''' {{APIComment|Precision for labels on X-axis.}}
{{APIComment|'Set the plot settings.}}
*'''[[WAPlotSettings.PlotXTolerance|PlotXTolerance]]''' {{APIComment|Tolerance for labels on X-axis.}}
  NewPlotSettings.UserName = ""
*'''[[WAPlotSettings.PlotYPrecision|PlotYPrecision]]''' {{APIComment|Precision for labels on Y-axis.}}
  NewPlotSettings.UserCompany = ""
*'''[[WAPlotSettings.PlotYTolerance|PlotYTolerance]]''' {{APIComment|Tolerance for labels on Y-axis.}}
  NewPlotSettings.AutoscaleX = True
*'''[[WAPlotSettings.ShowLeftCensoredPoints|ShowLeftCensoredPoints]]''' {{APIComment|Whether to show left censored points on X-axis.}}
  NewPlotSettings.AutoscaleY = True
*'''[[WAPlotSettings.ShowLinesAroundInterval|ShowLinesAroundInterval]]''' {{APIComment|Whether to show vertical lines around an interval line.}}
  NewPlotSettings.Xmin = 0
*'''[[WAPlotSettings.ShowNumberInGroup|ShowNumberInGroup]]''' {{APIComment|Whether to show the number of points in the group for grouped data.}}
  NewPlotSettings.Xmax = 0
*'''[[WAPlotSettings.ShowParameterBar|ShowParameterBar]]''' {{APIComment|Whether to show the parameter bars as probability plot.}}
  NewPlotSettings.Ymin = 0
*'''[[WAPlotSettings.ShowParameterScales|ShowParameterScales]]''' {{APIComment|Whether to show the parameter scales as probability plot.}}
  NewPlotSettings.ymax = 0
*'''[[WAPlotSettings.ShowSuspensionPoints|ShowSuspensionPoints]]''' {{APIComment|Whether to show suspension points on X-axis.}}
  NewPlotSettings.ShowParameterBar = True
*'''[[WAPlotSettings.ShowTargetMarker|ShowTargetMarker]]''' {{APIComment|Whether to show the a marker on the intersection of target reliability and time lines.}}
  NewPlotSettings.ShowParameterScales = True
*'''[[WAPlotSettings.ShowTargetReliability|ShowTargetReliability]]''' {{APIComment|Whether to show the target reliability line.}}
  NewPlotSettings.ShowTargetReliability = True
*'''[[WAPlotSettings.ShowTargetTime|ShowTargetTime]]''' {{APIComment|Whether to show the target time line.}}
  NewPlotSettings.ShowTargetTime = True
*'''[[WAPlotSettings.StraightenGammaLine|StraightenGammaLine]]''' {{APIComment|Whether to streighten the probability line for Gamma and G-Gamma distributions.}}
  NewPlotSettings.ShowTargetMarker = True
*'''[[WAPlotSettings.TargetReliability|TargetReliability]]''' {{APIComment|The value of target reliability.}}
  NewPlotSettings.TargetReliability = 0
*'''[[WAPlotSettings.TargetTime|TargetTime]]''' {{APIComment|The value of target time.}}
  NewPlotSettings.TargetTime = 0
*'''[[WAPlotSettings.UserCompany|UserCompany]]''' {{APIComment|Company name that appears on the plot.}}
  NewPlotSettings.ShowSuspensionPoints = True
*'''[[WAPlotSettings.UserName|UserName]]''' {{APIComment|User name that appears on the plot.}}
  NewPlotSettings.ShowLeftCensoredPoints = True
*'''[[WAPlotSettings.Xmax|Xmax]]''' {{APIComment|X-scale end. Only used if AutoscaleX is false.}}
  NewPlotSettings.ShowLinesAroundInterval = True
*'''[[WAPlotSettings.Xmin|Xmin]]''' {{APIComment|X-scale start. Only used if AutoscaleX is false.}}
  NewPlotSettings.AdjustMLEPoints = True
*'''[[WAPlotSettings.Ymax|Ymax]]''' {{APIComment|Y-scale end. Only used if AutoscaleY is false.}}
  NewPlotSettings.StraightenGammaLine = True
*'''[[WAPlotSettings.Ymin|Ymin]]''' {{APIComment|Y-scale start. Only used if AutoscaleY is false.}}
  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
-->

Latest revision as of 22:53, 2 March 2018

APIWiki.png


Member of: SynthesisAPI


Represents the plot settings of an associated WAPlots object.

Constructor

Name Description
WAPlotSettings Creates an instance of the WAPlotSettings class.


Properties

Name Description
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. Default value = False.
AutoscaleX Indicates whether the plot automatically chooses the appropriate values for the X-axis. Boolean. Default value = True.
AutoscaleY Indicates whether the plot automatically chooses the appropriate values for the Y-axis. Boolean. Default value = True.
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.). Default value = 0 (no bounds).
ConfBounds_TypesSelected Gets or sets a value from the ConfBoundsTypes enumeration, which specifies the type of confidence bounds (e.g., type I or type II, etc.). Default value = 0 (no bounds).
ConfidenceLevel Gets or sets the confidence level. Double. Default value = 0.9
ContourConfLevel Gets or sets the confidence level for the contour line plot. Double. Default value = 0.9
HistogramInterval Gets or sets the interval in histogram plots. Double. Default value = 0 (interval is automatically calculated)
PlotXPrecision Gets or sets the math precision of the labels on the X-axis. Integer. Default value = 6.
PlotXTolerance Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. Integer. Default value = 6.
PlotYPrecision Gets or sets the math precision of the labels on the Y-axis. Integer. Default value = 6.
PlotYTolerance Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. Integer. Default value = 6.
Show3PWeibullAdjustedItems Indicate whether to display the adjusted failure points, lines, and confidence bounds for 3-parameter Weibull probability plot. Boolean. Default value = True.
Show3PWeibullUnadjustedItems Indicate whether to display the unadjusted failure points, lines, and confidence bounds for 3-parameter Weibull probability plot. Boolean. Default value = True.
ShowDataPoints Indicates whether to show the data points on probability and reliability plots. Boolean. Default value = True.
ShowLeftCensoredPoints Indicates whether to show the left censored points on the plot when plotting interval or left censored data. Boolean. Default value = False.
ShowLinesAroundInterval Indicates whether to show vertical lines around the points for interval censored data. Boolean. Default value = True.
ShowNumberInGroup Indicates whether to show the number of data points in the group for grouped data. Boolean. Default value = False.
ShowParameterBar Indicates whether to show a box around the parameter scales on a probability plot. Boolean. Default value = False.
ShowParameterScales Indicates whether to show the parameter scales on a probability plot. Boolean. Default value = False.
ShowSuspensionPoints Indicates whether to show the suspension (right-censored) data points on the plot when plotting suspended data. Boolean. Default value = False.
ShowTargetMarker Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. Boolean. Default value = False.
ShowTargetReliability Indicates whether to show the target reliability line on the plot. Boolean. Default value = False.
ShowTargetTime Indicates whether to show the target time line on the plot. Boolean. Default value = False.
StraightenGammaLine Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. Boolean. Default value = True.
TargetReliability Gets or sets the value of the target reliability. Double. Default value = 0.9
TargetTime Gets or sets the value of the target time. Double. Default value = 100
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
Xmax Gets or sets the maximum value for the X-axis. Applies only if AutoscaleX is false. Double. Default value = 1.
Xmin Gets or sets the minimum value for the X-axis. Applies only if AutoscaleX is false. Double. Default value = 0.
Ymax Gets or sets the maximum value for the Y-axis. Applies only if AutoscaleY is false. Double. Default value = 1.
Ymin Gets or sets the maximum value for the Y-axis. Applies only if AutoscaleY is false. Double. Default value = 0.


See Also

Retrieved from "https://www.reliawiki.com/index.php?title=WAPlotSettings_Class&oldid=65337"