XPlot


Surface

Constructors

ConstructorDescription
new()
Signature: unit -> Surface

Instance members

Instance memberDescription
colorscale()
Signature: unit -> string

Sets and/or defines the color scale for this trace. The string values are pre-defined color scales. For custom color scales, define an array of value-color pairs where, the first element of the pair corresponds to a normalized value of z from 0-1, i.e. (z-zmin)/ (zmax-zmin), and the second element of pair corresponds to a color. Use with 'zauto', 'zmin' and 'zmax to fine-tune the map from 'z' to rendered colors.

colorscale()
Signature: unit -> unit

Sets and/or defines the color scale for this trace. The string values are pre-defined color scales. For custom color scales, define an array of value-color pairs where, the first element of the pair corresponds to a normalized value of z from 0-1, i.e. (z-zmin)/ (zmax-zmin), and the second element of pair corresponds to a color. Use with 'zauto', 'zmin' and 'zmax to fine-tune the map from 'z' to rendered colors.

name()
Signature: unit -> string

The label associated with this trace. This name will appear in the column header in the online spreadsheet.

name()
Signature: unit -> unit

The label associated with this trace. This name will appear in the column header in the online spreadsheet.

scene()
Signature: unit -> string

This key determines the scene on which this trace will be plotted in.

scene()
Signature: unit -> unit

This key determines the scene on which this trace will be plotted in.

ShouldSerializecolorscale()
Signature: unit -> bool
ShouldSerializename()
Signature: unit -> bool
ShouldSerializescene()
Signature: unit -> bool
ShouldSerializestream()
Signature: unit -> bool
ShouldSerializetype()
Signature: unit -> bool
ShouldSerializevisible()
Signature: unit -> bool
ShouldSerializex()
Signature: unit -> bool
ShouldSerializey()
Signature: unit -> bool
ShouldSerializez()
Signature: unit -> bool
stream()
Signature: unit -> Stream

Links a dictionary that initializes this trace as a writable-stream, for use with the streaming API.

stream()
Signature: unit -> unit

Links a dictionary that initializes this trace as a writable-stream, for use with the streaming API.

type()
Signature: unit -> string

Plotly identifier for this data's trace type.

type()
Signature: unit -> unit

Plotly identifier for this data's trace type.

visible()
Signature: unit -> string

Toggles whether or not this object will be visible on the rendered figure.

visible()
Signature: unit -> unit

Toggles whether or not this object will be visible on the rendered figure.

x()
Signature: unit -> obj

Sets the horizontal coordinates referring to the columns of the 2d array linked to 'z'. If the 'z' is an array of strings, then the x-labels are spaced evenly. If the dimensions of the 2d array linked to 'z' are (n x m), the length of the 'x' array should equal m.

x()
Signature: unit -> unit

Sets the horizontal coordinates referring to the columns of the 2d array linked to 'z'. If the 'z' is an array of strings, then the x-labels are spaced evenly. If the dimensions of the 2d array linked to 'z' are (n x m), the length of the 'x' array should equal m.

y()
Signature: unit -> obj

Sets the vertical coordinates referring to the rows of the 2d array linked to 'z'. If strings, the y-labels are spaced evenly. If the dimensions of the 2d array linked to 'z' are (n x m), the length of the 'y' array should equal n.

y()
Signature: unit -> unit

Sets the vertical coordinates referring to the rows of the 2d array linked to 'z'. If strings, the y-labels are spaced evenly. If the dimensions of the 2d array linked to 'z' are (n x m), the length of the 'y' array should equal n.

z()
Signature: unit -> obj

Sets the surface coordinates. Say the dimensions of the 2d array linked to 'z' has n rows and m columns then the resulting contour will have n coordinates along the y-axis and m coordinates along the x-axis. Therefore, the i-th row/ j-th column cell in the 2d array linked to 'z' is mapped to the i-th partition of the y-axis and the j-th partition of the x-axis

z()
Signature: unit -> unit

Sets the surface coordinates. Say the dimensions of the 2d array linked to 'z' has n rows and m columns then the resulting contour will have n coordinates along the y-axis and m coordinates along the x-axis. Therefore, the i-th row/ j-th column cell in the 2d array linked to 'z' is mapped to the i-th partition of the y-axis and the j-th partition of the x-axis

Fork me on GitHub