CB.ScatterPrefsND

This call sets preferences for the selected scatter chart. If more than one scatter chart is open and no chart is selected, this call returns a cbErrNoSelection error for CB.MacroResult.

Table 156. Parameters for CB.ScatterPrefsND

Parameter

VBA Data Type

Description

Index

Integer

Works with Value to set scatter chart preferences. For named constant and index values, see Table 157.

Value

Integer

Works with Index to set scatter chart preferences. For named constant and index values, see Table 158.

Table 157, following, lists named constant and index values for the Index parameter.

Table 157. CB.ScatterPrefsND Index Parameter Values — Required, Integer

Named Constant Value

Index Value

Description

cbScatterTitle

1

Defines the scatter title according to the supplied string value (title text)

cbScatterManageFore

2

Adds or removes the selected forecast to or from the chart, according to Value

cbScatterManageAssum

3

Adds or removes the selected assumption to or from the chart, according to Value

cbScatterSetTarget

5

If True, sets the target value required for Scatter View; if False, clears it

cbScatterViewType

6

Specifies the scatter view type according to Value

cbScatterPlotSize

7

Specifies the scatter plot size with a value from 1-10; 1 is the smallest plot and 10 is the largest

cbScatterDrawPoints

8

If True, displays scatter points; if False, does not display them

cbScatterPointSymbol

9

Specifies the scatter point symbol, according to Value

cbScatterPointSize

10

Specifies the size of scatter points in pixels (1-30)

cbScatterPointColor

11

Specifies the scatter point color (0-15 as defined in the Chart Preferences dialog, Chart Type tab; 0 = Auto)

cbScatterDrawLines

12

If True, displays a fit line on the scatter chart; if False, lines do not appear

cbScatterLineWidth

13

Specifies the scatter line width in pixels (1-10)

cbScatterLineType

14

Specifies the type of scatter line, according to Value

cbScatterLineColor

15

Specifies the scatter line color (0-15 as defined in the Chart Preferences dialog, Chart Type tab; 0 = Auto)

cbScatterCriteriaLimit

16

Specifes the scatter chart criteria to use, according to Value

cbScatterCriteriaLimitNumber

17

Defines the number of trials to appear, taken into account only if cbScatterCriteriaLimit = LimitTrialNumber (Value)

cbScatterCriteriaLimitPercentage

18

Defines the percentage of trials to show, taken into account only if cbScatterCriteriaLimit = LimitTrialPercentage (Value) with a possible range of 1-100

cbScatterDrawCorrelationCoefficient

19

If True, displays a correlation coefficient for each plot; if False does not display the correlation

cbScatterShowFilteredOutValues

20

If True, displays filtered out values; if False, does not display filtered out values; boolean

cbScatterShowLinearRegressionCoefficients

21

If True, displays the slope and Y-intercept for the linear regression line on each plot; if False does not display this information

Table 158, following, lists named constant and index values for the Value parameter.

Table 158. CB.ScatterPrefsND Value Parameter Values — Required, Integer

Used With Specified Values of Index

Named Constant Value

Index Value

Description

For Index 2, 3: Integer

cbScatterAddSelectedVar

1

Adds selected variable to scatter chart

For Index 2, 3: Integer

cbScatterRemoveSelectedVar

2

Removes selected variable from scatter chart

For Index 2, 3: Integer

cbScatterRemoveAllVars

3

Removes all variables from scatter chart

For Index 6: Integer

cbScatterView

1

Plots each selected assumption or forecast against a target (specified with Index =5)

For Index 6: Integer

cbMatrixView

2

Plots each selected assumption or forecast against every other selected variable

For Index 9: Integer

cbScatterPointSymbolRectangle

1

Draws rectangular scatter points

For Index 9: Integer

cbScatterPointSymbolCircle

2

Draws circular scatter points

For Index 9: Integer

cbScatterPointSymbolTriangle

3

Draws triangular scatter points

For Index 9: Integer

cbScatterPointSymbolDiamond

4

Draws diamond-shaped scatter points

For Index 9: Integer

cbScatterPointSymbolMarble

5

Draws spherical scatter points (default)

For Index 9: Integer

cbScatterPointSymbolHorizontalLine

6

Uses a horizontal line for scatter points

For Index 9: Integer

cbScatterPointSymbolVerticalLine

7

Uses a vertical line for scatter points

For Index 9: Integer

cbScatterPointSymbolCross

8

Uses a crossed line (+) for scatter points

For Index 9: Integer

cbScatterPointSymbolInvertedTriangle

9

Uses an inverted triangle for scatter points

For Index 14: Integer

cbScatterOrderedFit

1

Specifies an ordered fit line

For Index 14: Integer

cbScatterRegression

2

Specifies a linear regression line

For Index 16: Integer

cbScatterLimitAuto

1

Automatically limits the number of trials based on plot size

For Index 16: Integer

cbScatterLimitTrialNumber

2

Shows only a fixed number of trials defined through Index 17, cbScatterCriteriaLimitNumber

For Index 16: Integer

cbScatterLimitTrialPercentage

3

Shows only the specified percentage of trials defined through Index 18, cbScatterCriteriaLimitPercentage