WAPlotSettings Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
== Syntax==
== Syntax==


{{Template:WAPlotSettings.UserName|UserName}}
*'''[[WAPlotSettings.UserName|UserName]]''' {{APIComment|User name that appears on the plot.}}
 
*'''[[WAPlotSettings.UserCompany|UserCompany]]''' {{APIComment|Company name that appears on the plot.}}
{{Template:WAPlotSettings.UserCompany}}
*'''[[WAPlotSettings.AutoscaleX|AutoscaleX]]''' {{APIComment|Whether the X-scale is calculated automatically.}}
 
*'''[[WAPlotSettings.AutoscaleY|AutoscaleY]]''' {{APIComment|Whether the Y-scale is calculated automatically.}}
{{Template:WAPlotSettings.AutoscaleX}}
*'''[[WAPlotSettings.Xmin|Xmin]]''' {{APIComment|X-scale start. Only used if AutoscaleX is false.}}
 
*'''[[WAPlotSettings.Xmax|Xmax]]''' {{APIComment|X-scale end. Only used if AutoscaleX is false.}}
{{Template:WAPlotSettings.AutoscaleY}}
*'''[[WAPlotSettings.Ymin|Ymin]]''' {{APIComment|Y-scale start. Only used if AutoscaleY is false.}}
 
*'''[[WAPlotSettings.Ymax|Ymax]]''' {{APIComment|Y-scale end. Only used if AutoscaleY is false.}}
{{Template:WAPlotSettings.Xmin}}
*'''[[WAPlotSettings.ShowParameterBar|ShowParameterBar]]''' {{APIComment|Whether to show the parameter bars as probability plot.}}
 
*'''[[WAPlotSettings.ShowParameterScales|ShowParameterScales]]''' {{APIComment|Whether to show the parameter scales as probability plot.}}
{{Template:WAPlotSettings.Xmax}}
*'''[[WAPlotSettings.ShowTargetReliability|ShowTargetReliability]]''' {{APIComment|Whether to show the target reliability line.}}
 
*'''[[WAPlotSettings.ShowTargetTime|ShowTargetTime]]''' {{APIComment|Whether to show the target time line.}}
{{Template:WAPlotSettings.Ymin}}
*'''[[WAPlotSettings.ShowTargetMarker|ShowTargetMarker]]''' {{APIComment|Whether to show the a marker on the intersection of target reliability and time lines.}}
 
*'''[[WAPlotSettings.TargetReliability|TargetReliability]]''' {{APIComment|The value of target reliability.}}
{{Template:WAPlotSettings.Ymax}}
*'''[[WAPlotSettings.TargetTime|TargetTime]]''' {{APIComment|The value of target time.}}
 
*'''[[WAPlotSettings.ShowSuspensionPoints|ShowSuspensionPoints]]''' {{APIComment|Whether to show suspension points on X-axis.}}
{{Template:WAPlotSettings.ShowParameterBar}}
*'''[[WAPlotSettings.ShowLeftCensoredPoints|ShowLeftCensoredPoints]]''' {{APIComment|Whether to show left censored points on X-axis.}}
 
*'''[[WAPlotSettings.ShowLinesAroundInterval|ShowLinesAroundInterval]]''' {{APIComment|Whether to show vertical lines around an interval line.}}
{{Template:WAPlotSettings.ShowParameterScales}}
*'''[[WAPlotSettings.AdjustMLEPoints|AdjustMLEPoints]]''' {{APIComment|Whether to adjust MLE points.}}
 
*'''[[WAPlotSettings.StraightenGammaLine|StraightenGammaLine]]''' {{APIComment|Whether to streighten the probability line for Gamma and G-Gamma distributions.}}
{{Template:WAPlotSettings.ShowTargetReliability}}
*'''[[WAPlotSettings.ShowNumberInGroup|ShowNumberInGroup]]''' {{APIComment|Whether to show the number of points in the group for grouped data.}}
 
*'''[[WAPlotSettings.PlotXPrecision|PlotXPrecision]]''' {{APIComment|Precision for labels on X-axis.}}
{{Template:WAPlotSettings.ShowTargetTime}}
*'''[[WAPlotSettings.PlotYPrecision|PlotYPrecision]]''' {{APIComment|Precision for labels on Y-axis.}}
 
*'''[[WAPlotSettings.PlotXTolerance|PlotXTolerance]]''' {{APIComment|Tolerance for labels on X-axis.}}
{{Template:WAPlotSettings.ShowTargetMarker}}
*'''[[WAPlotSettings.PlotYTolerance|PlotYTolerance]]''' {{APIComment|Tolerance for labels on Y-axis.}}
 
*'''[[WAPlotSettings.ConfBounds_SideSelected|ConfBounds_SideSelected]]''' {{APIComment|Sides of the confidence bounds.}}
{{Template:WAPlotSettings.TargetReliability}}
*'''[[WAPlotSettings.ConfBounds_TypesSelected|ConfBounds_TypesSelected]]''' {{APIComment|Type of the confidence bounds.}}
 
*'''[[WAPlotSettings.ConfidenceLevel|ConfidenceLevel]]''' {{APIComment|Confidence level.}}
{{Template:WAPlotSettings.TargetTime}}
*'''[[WAPlotSettings.ContourConfLevel|ContourConfLevel]]''' {{APIComment|Confidence level for contour line plot.}}
 
*'''[[WAPlotSettings.HistogramInterval|HistogramInterval]]''' {{APIComment|Interval in histogram plots. Set it to 0 to use the automatically calculated interval.}}
{{Template:WAPlotSettings.ShowSuspensionPoints}}
 
{{Template:WAPlotSettings.ShowLeftCensoredPoints}}
 
{{Template:WAPlotSettings.ShowLinesAroundInterval}}
 
{{Template:WAPlotSettings.AdjustMLEPoints}}
 
{{Template:WAPlotSettings.StraightenGammaLine}}
 
{{Template:WAPlotSettings.ShowNumberInGroup}}
 
{{Template:WAPlotSettings.PlotXPrecision}}
 
{{Template:WAPlotSettings.PlotYPrecision}}
 
{{Template:WAPlotSettings.PlotXTolerance}}
 
{{Template:WAPlotSettings.PlotYTolerance}}
 
{{Template:WAPlotSettings.ConfBounds_SideSelected}}
 
{{Template:WAPlotSettings.ConfBounds_TypesSelected}}
 
{{Template:WAPlotSettings.ConfidenceLevel}}
 
{{Template:WAPlotSettings.ContourConfLevel}}
 
{{Template:WAPlotSettings.HistogramInterval}}

Revision as of 16:05, 31 January 2014



This class describes various settings for the WAPlots.

Syntax