WAPlotSettings Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
No edit summary |
||
| (5 intermediate revisions by one other user not shown) | |||
| Line 14: | Line 14: | ||
{| {{APITable}} | {| {{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''' | | 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''' | |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''' | |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.) | |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 | |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''' | |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''' | |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 | |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''' | |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''' | |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''' | |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''' | |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. | ||
|- | |- | ||
|TargetTime||Gets or sets the value of the target time. '''Double''' | |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''' | |UserCompany||Gets or sets the company name that appears on the plot. '''String''' | ||
| Line 66: | Line 72: | ||
|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''' | ||
|- | |- | ||
|Xmax||Gets or sets the maximum value for the X-axis. Applies only if <code>AutoscaleX</code> is false. '''Double''' | |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''' | |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''' | |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''' | |Ymin||Gets or sets the maximum value for the Y-axis. Applies only if <code>AutoscaleY</code> is false. '''Double'''. Default value = 0. | ||
|} | |} | ||
==See Also== | ==See Also== | ||
*[[WAPlots.CreatePlot|WAPlots.CreatePlot Method]] | *[[WAPlots.CreatePlot|WAPlots.CreatePlot Method]] (.NET only) | ||
*[[WAPlots.CreatePlotVB6|WAPlots.CreatePlotVB6 Method]] (VBA/VB6 only) | |||
<!--- | <!--- | ||
=Usage Example= | =Usage Example= | ||
Latest revision as of 22:53, 2 March 2018
 |
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
- WAPlots.CreatePlot Method (.NET only)
- WAPlots.CreatePlotVB6 Method (VBA/VB6 only)