WAPlots.CreatePlotVB6: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) (Created page with '{{Template:APIClass|WAPlots Class|WAPlots}} == Declaration == {{APIPrefix|Function}} {{APIName|CreatePlotVB6(}} {{APIPrefix|ByVal}} {{APIName|PlotType}} {{APIPrefix|As}} {{API…') |
Kate Racaza (talk | contribs) No edit summary |
||
(15 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb|.[[WAPlots_Class|WAPlots]]}} | ||
<onlyinclude>Returns a bitmap object that represents the plot. (VBA/VB6 only.)</onlyinclude> | |||
{{APIComment| | == Syntax == | ||
'''.CreatePlotVB6'''(''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. | |||
''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 Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] object. | |||
:OR | |||
*Use the [[WAPlots.AddModel]] method to add a [[CModel Class|cModel]] object. | |||
The following example uses a <code>WeibullDataSet</code> object to create the plot. | |||
'''VBA''' | |||
{{APIComment|'Declare a WeibullDataSet object.}} | |||
{{APIPrefix|Dim}} WDS {{APIPrefix|As New}} WeibullDataSet | |||
{{APIComment|'Add failures to the data set.}} | |||
{{APIPrefix|Call}} WDS.AddFailure(1, 1) | |||
{{APIPrefix|Call}} WDS.AddFailure(2, 1) | |||
{{APIPrefix|Call}} 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.}} | |||
{{APIPrefix|Call}} MyPlot.AddDataset(WDS) | |||
{{APIComment|'Create a Probability plot and display it. This example assumes that an image control called "Image1"}} | |||
{{APIComment|'already exists in the active Excel sheet.}} | |||
{{APIPrefix|Set}} Image1.Picture = MyPlot.CreatePlotVB6(WAPlotType_Probability) |
Latest revision as of 16:29, 24 June 2016
Member of: SynthesisAPI.WAPlots
Returns a bitmap object that represents the plot. (VBA/VB6 only.)
Syntax
.CreatePlotVB6(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.
VBA 'Declare a WeibullDataSet object. Dim WDS As New WeibullDataSet 'Add failures to the data set. Call WDS.AddFailure(1, 1) Call WDS.AddFailure(2, 1) Call 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. Call MyPlot.AddDataset(WDS) 'Create a Probability plot and display it. This example assumes that an image control called "Image1" 'already exists in the active Excel sheet. Set Image1.Picture = MyPlot.CreatePlotVB6(WAPlotType_Probability)