XPlot


Contour

Constructors

ConstructorDescription
new()
Signature: unit -> Contour

Instance members

Instance memberDescription
autocontour()
Signature: unit -> string

Toggle whether or not the contour parameters are picked automatically by Plotly. If FALSE, declare the contours parameters in 'contours'.

autocontour()
Signature: unit -> unit

Toggle whether or not the contour parameters are picked automatically by Plotly. If FALSE, declare the contours parameters in 'contours'.

colorbar()
Signature: unit -> Colorbar

Links a dictionary defining the parameters of the color bar associated with this trace (including its title, length and width).

colorbar()
Signature: unit -> unit

Links a dictionary defining the parameters of the color bar associated with this trace (including its title, length and width).

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.

connectgaps()
Signature: unit -> string

Toggle whether or not missing data points (i.e. '' or NaN) linked to 'x' and/or 'y', are added in by Plotly using linear interpolation.

connectgaps()
Signature: unit -> unit

Toggle whether or not missing data points (i.e. '' or NaN) linked to 'x' and/or 'y', are added in by Plotly using linear interpolation.

contours()
Signature: unit -> Contours

Links a dictionary defining the parameters of the contours of this trace.

contours()
Signature: unit -> unit

Links a dictionary defining the parameters of the contours of this trace.

dx()
Signature: unit -> float

Spacing between x-axis coordinates. Use with 'x0' an alternative to an 'x' array. Has no effect if 'x' is set.

dx()
Signature: unit -> unit

Spacing between x-axis coordinates. Use with 'x0' an alternative to an 'x' array. Has no effect if 'x' is set.

dy()
Signature: unit -> float

Spacing between y-axis coordinates. Use with 'y0' an alternative to an 'y' array. Has no effect if 'y' is set.

dy()
Signature: unit -> unit

Spacing between y-axis coordinates. Use with 'y0' an alternative to an 'y' array. Has no effect if 'y' is set.

line()
Signature: unit -> Line

Links a dictionary containing line parameters for contour lines of this contour trace (including line width, dash, color and smoothing level). Has no an effect if 'showlines' is set to FALSE in 'contours'.

line()
Signature: unit -> unit

Links a dictionary containing line parameters for contour lines of this contour trace (including line width, dash, color and smoothing level). Has no an effect if 'showlines' is set to FALSE in 'contours'.

name()
Signature: unit -> string

The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet.

name()
Signature: unit -> unit

The label associated with this trace. This name will appear in the legend, on hover and in the column header in the online spreadsheet.

ncontours()
Signature: unit -> float

Specifies the number of contours lines in the contour plot. No need to set 'autocontour' to False for 'ncontours' to apply.

ncontours()
Signature: unit -> unit

Specifies the number of contours lines in the contour plot. No need to set 'autocontour' to False for 'ncontours' to apply.

opacity()
Signature: unit -> float

Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.

opacity()
Signature: unit -> unit

Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.

reversescale()
Signature: unit -> string

Toggle whether or not the color scale will be reversed.

reversescale()
Signature: unit -> unit

Toggle whether or not the color scale will be reversed.

ShouldSerializeautocontour()
Signature: unit -> bool
ShouldSerializecolorbar()
Signature: unit -> bool
ShouldSerializecolorscale()
Signature: unit -> bool
ShouldSerializeconnectgaps()
Signature: unit -> bool
ShouldSerializecontours()
Signature: unit -> bool
ShouldSerializedx()
Signature: unit -> bool
ShouldSerializedy()
Signature: unit -> bool
ShouldSerializeline()
Signature: unit -> bool
ShouldSerializename()
Signature: unit -> bool
ShouldSerializencontours()
Signature: unit -> bool
ShouldSerializeopacity()
Signature: unit -> bool
ShouldSerializereversescale()
Signature: unit -> bool
ShouldSerializeshowlegend()
Signature: unit -> bool
ShouldSerializeshowscale()
Signature: unit -> bool
ShouldSerializestream()
Signature: unit -> bool
ShouldSerializetype()
Signature: unit -> bool
ShouldSerializevisible()
Signature: unit -> bool
ShouldSerializex()
Signature: unit -> bool
ShouldSerializex0()
Signature: unit -> bool
ShouldSerializexaxis()
Signature: unit -> bool
ShouldSerializextype()
Signature: unit -> bool
ShouldSerializey()
Signature: unit -> bool
ShouldSerializey0()
Signature: unit -> bool
ShouldSerializeyaxis()
Signature: unit -> bool
ShouldSerializeytype()
Signature: unit -> bool
ShouldSerializez()
Signature: unit -> bool
ShouldSerializezauto()
Signature: unit -> bool
ShouldSerializezmax()
Signature: unit -> bool
ShouldSerializezmin()
Signature: unit -> bool
showlegend()
Signature: unit -> string

Toggle whether or not this trace will be labeled in the legend.

showlegend()
Signature: unit -> unit

Toggle whether or not this trace will be labeled in the legend.

showscale()
Signature: unit -> bool

Toggle whether or not the color scale associated with this mapping will be shown alongside the figure.

showscale()
Signature: unit -> unit

Toggle whether or not the color scale associated with this mapping will be shown alongside the figure.

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.

x0()
Signature: unit -> float

The location of the first coordinate of the x-axis. Use with 'dx' an alternative to an 'x' array. Has no effect if 'x' is set.

x0()
Signature: unit -> unit

The location of the first coordinate of the x-axis. Use with 'dx' an alternative to an 'x' array. Has no effect if 'x' is set.

xaxis()
Signature: unit -> string

This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to 'xaxis' in 'layout', 'x2' references to 'xaxis2' in 'layout', and so on. Note that 'x1' will always refer to 'xaxis' or 'xaxis1' in 'layout', they are the same.

xaxis()
Signature: unit -> unit

This key determines which x-axis the x-coordinates of this trace will reference in the figure. Values 'x1' and 'x' reference to 'xaxis' in 'layout', 'x2' references to 'xaxis2' in 'layout', and so on. Note that 'x1' will always refer to 'xaxis' or 'xaxis1' in 'layout', they are the same.

xtype()
Signature: unit -> string

If set to 'scaled' and 'x' is linked to an array, then the horizontal labels are scaled to an array of integers of unit step starting from 0.

xtype()
Signature: unit -> unit

If set to 'scaled' and 'x' is linked to an array, then the horizontal labels are scaled to an array of integers of unit step starting from 0.

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.

y0()
Signature: unit -> float

The location of the first coordinate of the y-axis. Use with 'dy' an alternative to an 'y' array. Has no effect if 'y' is set.

y0()
Signature: unit -> unit

The location of the first coordinate of the y-axis. Use with 'dy' an alternative to an 'y' array. Has no effect if 'y' is set.

yaxis()
Signature: unit -> string

This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to 'yaxis' in 'layout', 'y2' references to 'yaxis2' in 'layout', and so on. Note that 'y1' will always refer to 'yaxis' or 'yaxis1' in 'layout', they are the same.

yaxis()
Signature: unit -> unit

This key determines which y-axis the y-coordinates of this trace will reference in the figure. Values 'y1' and 'y' reference to 'yaxis' in 'layout', 'y2' references to 'yaxis2' in 'layout', and so on. Note that 'y1' will always refer to 'yaxis' or 'yaxis1' in 'layout', they are the same.

ytype()
Signature: unit -> string

If set to 'scaled' and 'y' is linked to an array, then the vertical labels are scaled to an array of integers of unit step starting from 0.

ytype()
Signature: unit -> unit

If set to 'scaled' and 'y' is linked to an array, then the vertical labels are scaled to an array of integers of unit step starting from 0.

z()
Signature: unit -> obj

Sets the data that describes the contour map mapping. Say the dimensions of the 2d array linked to 'z' has n rows and m columns then the resulting contour map will show n partitions along the y-axis and m partitions 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 (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot).

z()
Signature: unit -> unit

Sets the data that describes the contour map mapping. Say the dimensions of the 2d array linked to 'z' has n rows and m columns then the resulting contour map will show n partitions along the y-axis and m partitions 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 (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot).

zauto()
Signature: unit -> string

Toggle whether or not the default values of 'zmax' and 'zmax' can be overwritten.

zauto()
Signature: unit -> unit

Toggle whether or not the default values of 'zmax' and 'zmax' can be overwritten.

zmax()
Signature: unit -> float

Sets the maximum 'z' data value to be resolved by the color scale. Its default value is the maximum of the 'z' data values. This value will be used as the maximum in the color scale normalization. For more info see 'colorscale'.

zmax()
Signature: unit -> unit

Sets the maximum 'z' data value to be resolved by the color scale. Its default value is the maximum of the 'z' data values. This value will be used as the maximum in the color scale normalization. For more info see 'colorscale'.

zmin()
Signature: unit -> float

Sets the minimum 'z' data value to be resolved by the color scale. Its default value is the minimum of the 'z' data values. This value will be used as the minimum in the color scale normalization. For more info see 'colorscale'.

zmin()
Signature: unit -> unit

Sets the minimum 'z' data value to be resolved by the color scale. Its default value is the minimum of the 'z' data values. This value will be used as the minimum in the color scale normalization. For more info see 'colorscale'.

Fork me on GitHub