WAPlots.CreatePlot: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIClass|WAPlots Class|WAPlots}}
{{Template:API}}{{Template:APIBreadcrumb|.[[WAPlots_Class|WAPlots]]}}
{{Template:WAPlots.CreatePlot.Cmt}}
 
 
<onlyinclude>Returns a bitmap object that represents the plot. (.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
*CreatePlot( PlotType {{APIPrefix|As}} [[WAPlotType Enumeration|WAPlotType]], {{APIPrefix|Optional}} UserSettings {{APIPrefix|As}} [[WAPlotSettings Class|WAPlotSettings ]] = {{APIPrefix|Nothing}} , {{APIPrefix|Optional}} Width {{APIPrefix|As Integer}} = 1150, {{APIPrefix|Optional }} Height {{APIPrefix|As Integer}} = 800) {{APIPrefix|As System.Drawing.Bitmap}}
'''.CreatePlot'''(''PlotType'', ''UserSettings'', ''Width'', ''Height'')
 
===Parameters===
''PlotType''
:Required. The type of plot to create. Can be any [[WAPlotType Enumeration|WAPlotType]] constant.
 
''UserSettings''
:Optional. The [[WAPlotSettings Class|WAPlotSettings ]] object that represents the plot's settings.  


Parameters
''Width''
:''PlotType'': The plot type, specified with the [[WAPlotType Enumeration|WAPlotType]] enumeration.
:Optional. Integer. The plot width. Default value = 1150 pixels.


:''UserSettings'': The plot settings, specified as a [[WAPlotSettings Class|WAPlotSettings]] object.
''Height''
:Optional. Integer. The plot height. Default value = 800 pixels.


:''Width'': The width, in pixels, of the finished plot.
== Example ==
To create a plot, you must first add an object to the plot:
*Use the [[WAPlots.AddDataset]] method to add either a calculated [[WeibullDataSet Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] object.
:OR
*Use the [[WAPlots.AddModel]] method to add a [[CModel Class|cModel]] object.  


:''Height'': The height, in pixels, of the finished plot.


== Usage Example ==
The following example uses a <code>WeibullDataSet</code> object to create the plot.
  {{APIComment|'Create a new Weibull/ALTA Plot instance. See [[WAPlots.CreatePlot|CreatePlot]].}}
 
  Dim WeibullALTAPlot As New WAPlots
  '''VB.NET'''
    
    
  {{APIComment|'Declare a WeibullDataSet. See [[WeibullDataSet Class|WeibullDataSet]].}}
  {{APIComment|'Declare a WeibullDataSet object.}}
  Dim WDS As New WeibullDataSet
  {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
    
    
  {{APIComment|'Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]].}}
  {{APIComment|'Add failures to the data set.}}
  WDS.AddFailure(1, 1)
  WDS.AddFailure(1, 1)
  WDS.AddFailure(2, 1)
  WDS.AddFailure(2, 1)
  WDS.AddFailure(3, 1)
  WDS.AddFailure(3, 1)
    
    
  {{APIComment|'Specify that it will be based on the WDS data set.}}
  {{APIComment|'Fit the data to the life distribution, using all default analysis settings.}} 
  WeibullALTAPlot.AddDataset(WDS)
  WDS.Calculate
{{APIComment|'Create a WAPlots object.}}
  {{APIPrefix|Dim}} MyPlot {{APIPrefix|As New}} WAPlots
{{APIComment|'Add the calculated data set to the plot.}}
  MyPlot.AddDataset(WDS)
   
   
  {{APIComment|'Create a Probability plot and save it as a bitmap file. See [[WAPlotType Enumeration|WAPlotType]] for plot types.}}
  {{APIComment|'Create a Probability plot and display it. This example assumes that a PictureBox control called "PictureBox1"}}
  Dim FinalPlot As Bitmap = WeibullALTAPlot.CreatePlot(WAPlotType.Probability)
{{APIComment|'already exists in the Windows Form project.}}
  PictureBox1.Image = MyPlot.CreatePlot(WAPlotType.Probability)

Latest revision as of 15:11, 3 August 2017

APIWiki.png


Member of: SynthesisAPI.WAPlots


Returns a bitmap object that represents the plot. (.NET only)

Syntax

.CreatePlot(PlotType, UserSettings, Width, Height)

Parameters

PlotType

Required. The type of plot to create. Can be any WAPlotType constant.

UserSettings

Optional. The WAPlotSettings object that represents the plot's settings.

Width

Optional. Integer. The plot width. Default value = 1150 pixels.

Height

Optional. Integer. The plot height. Default value = 800 pixels.

Example

To create a plot, you must first add an object to the plot:

OR


The following example uses a WeibullDataSet object to create the plot.

VB.NET
 
 'Declare a WeibullDataSet object. 
  Dim WDS As New WeibullDataSet
 
 'Add failures to the data set. 
  WDS.AddFailure(1, 1)
  WDS.AddFailure(2, 1)
  WDS.AddFailure(3, 1)
 
 'Fit the data to the life distribution, using all default analysis settings.   
  WDS.Calculate

 'Create a WAPlots object.  
  Dim MyPlot As New WAPlots

 'Add the calculated data set to the plot. 
  MyPlot.AddDataset(WDS)

 'Create a Probability plot and display it. This example assumes that a PictureBox control called "PictureBox1" 
 'already exists in the Windows Form project. 
  PictureBox1.Image = MyPlot.CreatePlot(WAPlotType.Probability)