WAPlotSettings Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


Represents the plot settings of an associated [[WAPlots Class|WAPlots]] object.
Represents the plot settings of an associated [[WAPlots Class|WAPlots]] object.
== Constructor==
{| {{APITable}}
|-
| style="width: 180px;"|WAPlotSettings||Creates an instance of the WAPlotSettings class.
|}


== Properties==
== Properties==
{| {{APITable}}
{| {{APITable}}
|-
|-
| style="width: 180px;"|
| 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'''
|-
|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'''
|-
|-
|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.)  
|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.)  
Line 17: Line 28:
|ContourConfLevel||Gets or sets the confidence level for the contour line plot. '''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'''.
|HistogramInterval||Gets or sets the interval in histogram plots. Set it to 0 to use the automatically calculated interval. '''Double'''
|-
|-
|TargetReliability||Gets or sets the value of the target reliability. '''Double'''
|PlotXPrecision||Gets or sets the math precision of the labels on the X-axis. '''Integer'''
|-
|-
|ShowTargetTime||Indicates whether to show the target time line on the plot. '''Boolean'''
|PlotXTolerance||Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. '''Integer'''
|-
|-
|TargetTime||Gets or sets the value of the target time. '''Double'''
|PlotYPrecision||Gets or sets the math precision of the labels on the Y-axis. '''Integer'''
|-
|-
|ShowTargetMarker||Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. '''Boolean'''
|PlotYTolerance||Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. '''Integer'''
|-
|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 <code>AutoscaleX</code> is false. '''Double'''
|-Xmin||Gets or sets the minimum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''
|-
|Ymax||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
|-
|Ymin||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
|-
|-
|ShowLeftCensoredPoints||Indicates whether to show the left censored points on the plot when plotting interval or left censored data. '''Boolean'''
|ShowLeftCensoredPoints||Indicates whether to show the left censored points on the plot when plotting interval or left censored data. '''Boolean'''
Line 50: Line 50:
|ShowSuspensionPoints||Indicates whether to show the suspension (right-censored) data points on the plot when plotting suspended data. '''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'''
|ShowTargetMarker||Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. '''Boolean'''
|-
|ShowTargetReliability||Indicates whether to show the target reliability line on the plot. '''Boolean'''.
|-
|-
|PlotXTolerance||Gets or sets the point at which the plot will switch to scientific notation for the X-axis labels. '''Integer'''
|ShowTargetTime||Indicates whether to show the target time line on the plot. '''Boolean'''
|-
|-
|PlotYPrecision||Gets or sets the math precision of the labels on the Y-axis. '''Integer'''
|StraightenGammaLine||Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. '''Boolean'''
|-
|-
|PlotYTolerance||Gets or sets the point at which the plot will switch to scientific notation for the Y-axis labels. '''Integer'''
|TargetReliability||Gets or sets the value of the target reliability. '''Double'''
|-
|-
|HistogramInterval||Gets or sets the interval in histogram plots. Set it to 0 to use the automatically calculated interval. '''Double'''
|TargetTime||Gets or sets the value of the target time. '''Double'''
|-
|-
|UserCompany||Gets or sets the company name that appears on the plot. '''String'''
|UserCompany||Gets or sets the company name that appears on the plot. '''String'''
Line 64: Line 66:
|UserName||Gets or sets the user 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'''
|Xmax||Gets or sets the maximum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''
|-
|-
|StraightenGammaLine||Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. '''Boolean'''
|Xmin||Gets or sets the minimum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double'''
|-
|Ymax||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
|-
|Ymin||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''
|}
|}


<!---
=Usage Example=
=Usage Example=
  {{APIComment|'Create a new WAPlotSettings object.}}
  {{APIComment|'Create a new WAPlotSettings object.}}
Line 104: Line 111:
   NewPlotSettings.ContourConfLevel = 0
   NewPlotSettings.ContourConfLevel = 0
   NewPlotSettings.HistogramInterval = 0
   NewPlotSettings.HistogramInterval = 0
-->

Revision as of 18:39, 20 April 2016

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
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
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
HistogramInterval Gets or sets the interval in histogram plots. Set it to 0 to use the automatically calculated interval. Double
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
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
ShowTargetMarker Indicates whether to show a marker on the intersection of the target reliability and time lines on the plot. Boolean
ShowTargetReliability Indicates whether to show the target reliability line on the plot. Boolean.
ShowTargetTime Indicates whether to show the target time line on the plot. Boolean
StraightenGammaLine Indicates whether to straighten the parameter line on the probability plot for the gamma or generalized gamma distributions. Boolean
TargetReliability Gets or sets the value of the target reliability. Double
TargetTime Gets or sets the value of the target time. 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
Xmax Gets or sets the maximum value for the X-axis. Applies only if AutoscaleX is false. Double
Xmin Gets or sets the minimum 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


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