Function3D
Create a function 3D plot to visualize a function of three variables as a slice plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Function3D");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Function3D") creates a slice plot feature named <ftag> belonging to the 3D plot group <pgtag>.
Function 3D plots display a function of three variables as a colored 3D slice plot.
The following properties are available:
Table 7-50: Valid Properties for Function3D Plots.
Property
Value
Default
Description
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when coloring is gradient.
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use. Active when coloring is uniform.
coloring
colortable | uniform | gradient
colortable
How to color the surface: using a color table, a uniform color, or a color gradient.
colorlegend
on | off
on
Whether to show color legend, when coloring is set to colortable.
colorscalemode
linear | linearsymmetric | logarithmic
linear
Scaling of the color table: linear, linear symmetric around 0, or logarithmic, when coloring is set to colortable or gradient.
colortable
color table name
Rainbow
The color table to use when coloring is set to colortable. See Color Tables for a list of color tables.
colortabletrans
none | reverse | nonlinear | nonlinearsymmetric
none
Transformation of the color table, when coloring is set to colortable or gradient.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when color is set to custom.
customtopcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
data
none | parent | dataset name
parent
The dataset this feature refers to.
descr
String
Model dependent
The description of the expression in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
expr
String
Model dependent
The expression to plot: a function of two variables such as an1(x,y).
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
gendistance
double array
Empty
Vector of distances from base plane, indicating position of additional parallel planes. Active when genparaactive equals on and genpara equals number.
genmethod
threepoint | pointnormal
threepoint
Active when planetype equals general, this property indicates whether the plane should be specified by three points or through one point and a normal.
gennumber
positive integer
4
Number of additional parallel planes. Active when genparaactive equals on and genpara equals number.
genpara
gennumber | gendistances
number
Active when planetype equals general, and genparaactive equals on, this property indicates whether the additional parallel planes should be specify by a number or by a vector of relative distances.
genparaactive
on | off
off
Active when planetype equals general, this property indicates whether there should be additional parallel planes created.
genpnpoint
String array of length three
{"0","0","0"}
Active when genmethod equals pointnormal, this property contains the coordinates of the point.
genpnvec
String array of length three
{"0","0","0"}
Active when genmethod equals pointnormal, this property contains the normal vector.
genpoints
double matrix of size 3x3
{{0,0,0},
{1,0,0},
{0,1,0}}
Active when genmethod equals threepoint, this property contains the coordinates of the three points, with one row per point.
nonlinearcolortablerev
on | off
off
Whether to reverse to color table or gradient when coloring is set to colortable or gradient and colortabletrans is set to nonlinear or nonlinearsymmetric.
planetype
quick | general
yz
Specify plane type.
prefixintitle
String
Empty
Added prefix to contribution to title.
quickplane
xy | yz | zx
yz
Specify quick plane type. Active when planetype is quick.
quickx
String array
0
Absolute x-coordinates for planes, active when quickxmethod is set to coord.
quickxmethod
number | coord
number
Active when planetype equals quick and quickplane equals yz, this property indicates whether the planes should be specified by one or more absolute coordinates along the x-axis, or a number indicating the number of planes to distribute evenly.
quickxnumber
String
5
The number of planes when quickxmethod is set to number. It can contain a global expression for the number of slices.
quicky
String array
0
Absolute y-coordinates for planes, active when quickymethod is set to coord.
quickymethod
number | coord
number
Active when planetype equals quick and quickplane equals zx, this property indicates whether the planes should be specified by one or more absolute coordinates along the y-axis, or a number indicating the number of planes to distribute evenly.
quickynumber
String
5
The number of planes when quickymethod is set to number. It can contain a global expression for the number of slices.
quickz
String array
0
Absolute z-coordinates for planes, active when quickzmethod is set to coord.
quickzmethod
number | coord
number
Active when planetype equals quick and quickplane equals xy, this property indicates whether the planes should be specified by one or more absolute coordinates along the z-axis, or a number indicating the number of planes to distribute evenly.
quickznumber
String
5
The number of planes when quickzmethod is set to number. It can contain a global expression for the number of slices.
rangecoloractive
on | off
off
Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values.
rangecolormax
double
Plot dependent
The maximum color range value. Active when rangecoloractive is on.
rangecolormin
double
Plot dependent
The minimum color range value. Active when rangecoloractive is on.
rangedatactive
on | off
off
Whether to use the manual data range specified in rangedatamin and rangedatamax. Values outside the data range is not plotted.
rangedatamax
double
Plot dependent
The maximum data value. Active when rangedataactive is on.
rangedatamin
double
Plot dependent
The minimum data value. Active when rangedataactive is on.
suffixintitle
String
Empty
Added suffix to contribution to title.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | label | manual | none
auto
auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
topcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
white
The top color to use for a color gradient. Active when coloring is gradient.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String
 
The unit to use for the expression in expr.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
xunit
String
 
The unit to use for the x-axis in the plot.
yunit
String
 
The unit to use for the y-axis in the plot.
zunit
String
 
The unit to use for the z-axis in the plot.
Attributes
Filter (Plot Attribute); Transparency
See Also
Slice, Function, Function2D