WAPlots.CreatePlot: Difference between revisions

Latest revision as of 15:11, 3 August 2017

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:

Use the WAPlots.AddDataset method to add either a calculated WeibullDataSet or ALTADataSet object.

OR

Use the WAPlots.AddModel method to add a cModel object.

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|WAPlots Class|WAPlots}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[WAPlots_Class|WAPlots]]}}
-Create the plot based on the WeibullDataSet and/or the ALTADataSets entered into the WAPlots.  Returns a bitmap of the plot.
-== Method Syntax ==
+<onlyinclude>Returns a bitmap object that represents the plot. (.NET only)</onlyinclude>
-{{APIName|CreatePlot(}}
-{{APIPrefix|ByVal}}
-{{APIName|PlotType}}
-{{APIPrefix|As}}
-{{APIName|[[WAPlotType]],}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|UserSettings}}
-{{APIPrefix|As}}
-{{APIName|[[WAPlotSettings]]}}
-=
-{{APIPrefix|Nothing}}
-{{APIName|,}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|Width}}
-{{APIPrefix|As Integer}}
-=
-{{APIName|1150,}}
-{{APIPrefix|Optional ByVal}}
-{{APIName|Height}}
-{{APIPrefix|As Integer}}
-=
-{{APIName|800)}}
-{{APIPrefix|As System.Drawing.Bitmap}}
-{{APIComment|Creates a bitmap containing the plot image.}}
-== Parameters ==
+== Syntax ==
-'''PlotType'''
+ '''.CreatePlot'''(''PlotType'', ''UserSettings'', ''Width'', ''Height'')
-Set the type of plot desired, of the [[WAPlotType]] enum.
-'''UserSettings'''
+===Parameters===
-Sets the plot settings via an instance of the [[WAPlotSettings]] class.
+''PlotType''
+:Required. The type of plot to create. Can be any [[WAPlotType Enumeration|WAPlotType]] constant.
-'''Width'''
+''UserSettings''
-Set the width, in pixels, of the finished plot.
+:Optional. The [[WAPlotSettings Class|WAPlotSettings ]] object that represents the plot's settings.
-'''Height'''
+''Width''
-Set the height, in pixels, of the finished plot.
+:Optional. Integer. The plot width. Default value = 1150 pixels.
-== Usage Example ==
+''Height''
-{{APIComment|Create a new Weibull/ALTA Plot instance.}}
+:Optional. Integer. The plot height. Default value = 800 pixels.
-        Dim WeibullALTAPlot As New WAPlots
-{{APIComment|Declare a WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
+== Example ==
-        Dim WDS As New WeibullDataSet
+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.
-{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
-        WDS.AddFailure(1, 1)
-        WDS.AddFailure(2, 1)
-        WDS.AddFailure(3, 1)
-{{APIComment|Add the WeibullDataSet to the WAPlots.}}
+The following example uses a <code>WeibullDataSet</code> object to create the plot.
-        WeibullALTAPlot.AddDataset(WDS)
+ '''VB.NET'''
-{{APIComment|Create the WAPlot.  In this example, it will create a Probability plot.}}
-        Dim FinalPlot As Bitmap = WeibullALTAPlot.CreatePlot(WAPlotType.Probability)
+ {{APIComment|'Declare a WeibullDataSet object.}}
+   {{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet
+ {{APIComment|'Add failures to the data set.}}
+   WDS.AddFailure(1, 1)
+   WDS.AddFailure(2, 1)
+   WDS.AddFailure(3, 1)
+ {{APIComment|'Fit the data to the life distribution, using all default analysis settings.}}
+   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 display it. This example assumes that a PictureBox control called "PictureBox1"}}
+ {{APIComment|'already exists in the Windows Form project.}}
+   PictureBox1.Image = MyPlot.CreatePlot(WAPlotType.Probability)

WAPlots.CreatePlot: Difference between revisions

Latest revision as of 15:11, 3 August 2017

Syntax

Parameters

Example

Navigation menu

Search