DrawOption¶

drawopt.spad line 1 [edit on github]

DrawOption allows the user to specify defaults for the creation and rendering of plots.

=: (%, %) -> Boolean: from BasicType

~=: (%, %) -> Boolean: from BasicType

adaptive: Boolean -> %: adaptive(b) turns adaptive 2D plotting on if b is true, or off if b is false. This option is expressed in the form adaptive == b.

clip: Boolean -> %: clip(b) turns 2D clipping on if b is true, or off if b is false. This option is expressed in the form clip == b.

clip: List Segment Float -> %: clip([l]) provides ranges for user-defined clipping as specified in the list l. This option is expressed in the form clip == [l].

coerce: % -> OutputForm: from CoercibleTo OutputForm

colorFunction: ((DoubleFloat, DoubleFloat) -> DoubleFloat) -> %: colorFunction(f(u, v)) specifies the color for three dimensional plots as a function based upon the two parametric variables. This option is expressed in the form colorFunction == f(u, v).

colorFunction: ((DoubleFloat, DoubleFloat, DoubleFloat) -> DoubleFloat) -> %: colorFunction(f(x, y, z)) specifies the color for three dimensional plots as a function of x, y, and z coordinates. This option is expressed in the form colorFunction == f(x, y, z).

colorFunction: (DoubleFloat -> DoubleFloat) -> %: colorFunction(f(z)) specifies the color based upon the z-component of three dimensional plots. This option is expressed in the form colorFunction == f(z).

coord: (Point DoubleFloat -> Point DoubleFloat) -> %: coord(p) specifies a change of coordinates of point p. This option is expressed in the form coord == p.

coordinates: (Point DoubleFloat -> Point DoubleFloat) -> %: coordinates(p) specifies a change of coordinate systems of point p. This option is expressed in the form coordinates == p.

curveColor: Float -> %: curveColor(v) specifies a color, v, for 2D graph curves. This option is expressed in the form curveColor == v.

curveColor: Palette -> %: curveColor(p) specifies a color index for 2D graph curves from the spadcolors palette p. This option is expressed in the form curveColor ==p.

latex: % -> String: from SetCategory

option?: (List %, Symbol) -> Boolean: option?() is not to be used at the top level; option? internally returns true for drawing options which are indicated in a draw command, or false for those which are not.

option: (List %, Symbol) -> Union(Any, failed): option() is not to be used at the top level; option determines internally which drawing options are indicated in a draw command.

pointColor: Float -> %: pointColor(v) specifies a color, v, for 2D graph points. This option is expressed in the form pointColor == v.

pointColor: Palette -> %: pointColor(p) specifies a color index for 2D graph points from the spadcolors palette p. This option is expressed in the form pointColor == p.

range: List Segment Float -> %: range([l]) provides a user-specified range l. This option is expressed in the form range == [l].

range: List Segment Fraction Integer -> %: range([i]) provides a user-specified range i. This option is expressed in the form range == [i].

ranges: List Segment Float -> %: ranges(l) provides a list of user-specified ranges l. This option is expressed in the form ranges == l.

space: ThreeSpace DoubleFloat -> %: space specifies the space into which we will draw. If none is given then a new space is created.

style: String -> %: style(s) specifies the drawing style in which the graph will be plotted by the indicated string s. This option is expressed in the form style == s.

title: String -> %: title(s) specifies a title for a plot by the indicated string s. This option is expressed in the form title == s.

toScale: Boolean -> %: toScale(b) specifies whether or not a plot is to be drawn to scale; if b is true it is drawn to scale, if b is false it is not. This option is expressed in the form toScale == b.

tubePoints: PositiveInteger -> %: tubePoints(n) specifies the number of points, n, defining the circle which creates the tube around a 3D curve, the default is 6. This option is expressed in the form tubePoints == n.

tubeRadius: Float -> %: tubeRadius(r) specifies a radius, r, for a tube plot around a 3D curve; is expressed in the form tubeRadius == 4.

unit: List Float -> %: unit(lf) will mark off the units according to the indicated list lf. This option is expressed in the form unit == [f1, f2].

var1Steps: PositiveInteger -> %: var1Steps(n) indicates the number of subdivisions, n, of the first range variable. This option is expressed in the form var1Steps == n.

var2Steps: PositiveInteger -> %: var2Steps(n) indicates the number of subdivisions, n, of the second range variable. This option is expressed in the form var2Steps == n.

viewpoint: Record(theta: DoubleFloat, phi: DoubleFloat, scale: DoubleFloat, scaleX: DoubleFloat, scaleY: DoubleFloat, scaleZ: DoubleFloat, deltaX: DoubleFloat, deltaY: DoubleFloat) -> %: viewpoint(vp) creates a viewpoint data structure corresponding to the list of values. The values are interpreted as [theta, phi, scale, scaleX, scaleY, scaleZ, deltaX, deltaY]. This option is expressed in the form viewpoint == ls.

CoercibleTo OutputForm