ScatterVolume, ScatterSurface

Create a scatter plot on surfaces or in volumes.

Syntax

model.result(<pgtag>).create(<ftag>,"ScatterVolume");

model.result(<pgtag>).create(<ftag>,"ScatterSurface");

model.result(<pgtag>).feature(<ftag>).set(property, <value>);

model.result(<pgtag>).feature(<ftag>).run();

Description

model.result(<pgtag>).create(<ftag>,"Scatter...") creates a scatter plot feature named <ftag> belonging to the plot group <pgtag>.

Scatter plots are available in 2D and 3D.

The following properties are available:

Table 7-82: Valid Property/Value Pairs for Scatter Plots

Property	Value	Default	Description
arrowxmethod	number | coord	number	Indicates whether the x-coordinates of the spheres should be specified by number of points to distribute evenly across the data or by coordinates
arrowymethod	number | coord	number	Indicates whether the y-coordinates of the spheres should be specified by number of points to distribute evenly across the data or by coordinates
arrowzmethod	number | coord	number	Indicates whether the z-coordinates of the spheres should be specified by number of points to distribute evenly across the data or by coordinates. Available for ScatterVolume.
color	custom | black | blue | cyan | green | magenta | red | white | yellow	red	The color to use
colorexpr	String		The expression for the colors of the spheres
colordescr	String		A description of colorexpr
const	String array of property/value pairs	Empty	Parameters to use in the expressions
customcolor	RGB-triplet	{1,0,0} or last used color.	The uniform color to use. Active when color is set to custom.
data	none | parent | data set name	parent	The data set this feature refers to
descr	String	Model-dependent	The description of the expressions in expr. Is used in the automatic title.
descriptionintitle	on | off	on	Whether the title contribution should contain the description when titletype is custom
differential	on | off	on	Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
evalmethod	linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak	harmonic	Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
expr	String array of length 2 in 2D and 3 in 3D	Mode-dependent	The components to plot.
inheritcolor	Boolean	true	If inheritplot is not none: Determines if the color is inherited.
inheritplot	none | plot name	none	The plot that color and sphere scale is inherited from
inheritspherescale	Boolean	true	If inheritplot is not none: Determines if the sphere scale is inherited.
interp	double array	Time corresponding to last selected solnum for transient levels.	The time to use, for transient levels. Available when data is not parent and the underlying data is transient.
looplevel	array of non-negative integers and strings	Last solution for transient or parametric solution for each level. Otherwise first solution for each level.	The index of the solution to use, per level, or interp, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
outersolnum	non-negative integer	1	The index of the outer solutions to use. Applicable only for parametric sweep models.
prefixintitle	String	Empty	Added prefix to contribution to title
radiusexpr	String		The expression for the radii of the spheres
radiusdescr	String		A description of radiusexpr
solnum	non-negative integer	Last solution for transient or parametric solution. Otherwise first solution.	The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
solrepresentation	solnum | solutioninfo	solutioninfo	Indicates which method of selecting solutions is active
sphereradiusscale	double	1	The scale factor applied to the sphere radii if sphereradiusscaleactive is true.
sphereradiusscaleactive	Boolean	false	If true, sphereradiusscale is used; otherwise the scale factor is computed automatically.
suffixintitle	String	Empty	Added suffix to contribution to title
t	double	Time corresponding to last selected solnum.	The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
timeinterp	on | off	off	on if t is used to determine time steps, off if solnum is used
title	String	The auto-title.	The title to use when titletype is manual
titletype	auto | custom | manual | none	auto	auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. manual if the manual title contribution should be used (the title property). none if no title contribution should be used.
typeintitle	on | off	on	Whether the title contribution should contain the type when titletype is custom
xnumber	non-negative integer	15 (3D), 7 (2D)	Number of points in the x-direction. Active when arrowxmethod is set to number.
xcoord	double array	Empty	Absolute coordinates in the x-direction, active when arrowxmethod is set to coord
ynumber	integer	15 (3D), 7 (2D)	Number of points in the y-direction. Active when arrowymethod is set to number.
ycoord	double array	Empty	Absolute coordinates in the z-direction, active when arrowymethod is set to coord
znumber	integer	15 (3D), 7 (2D)	Number of points in the z-direction. Active when arrowzmethod is set to number. Available for ScatterVolume.
zcoord	double array	Empty	Absolute coordinates in the z-direction, active when arrowzmethod is set to coord. Available for ScatterVolume.

See Also

Surface, Volume