XPlot


Colorbar

Constructors

ConstructorDescription
new()
Signature: unit -> Colorbar

Instance members

Instance memberDescription
autotick()
Signature: unit -> string

Toggle whether or not the colorbar ticks parameters are picked automatically by Plotly. Once 'autotick' is set to FALSE, the colorbar ticks parameters can be declared with 'ticks', 'tick0', 'dtick0' and other tick-related key in this colorbar object.

autotick()
Signature: unit -> unit

Toggle whether or not the colorbar ticks parameters are picked automatically by Plotly. Once 'autotick' is set to FALSE, the colorbar ticks parameters can be declared with 'ticks', 'tick0', 'dtick0' and other tick-related key in this colorbar object.

bgcolor()
Signature: unit -> string

Sets the background (bg) color of this colorbar.

bgcolor()
Signature: unit -> unit

Sets the background (bg) color of this colorbar.

bordercolor()
Signature: unit -> string

Sets the color of the enclosing boarder of this colorbar.

bordercolor()
Signature: unit -> unit

Sets the color of the enclosing boarder of this colorbar.

borderwidth()
Signature: unit -> float

Sets the width of the boarder enclosing this colorbar

borderwidth()
Signature: unit -> unit

Sets the width of the boarder enclosing this colorbar

dtick()
Signature: unit -> float

Sets the distance between ticks on this colorbar.

dtick()
Signature: unit -> unit

Sets the distance between ticks on this colorbar.

exponentformat()
Signature: unit -> string

Sets how exponents show up. Here's how the number 1000000000 (1 billion) shows up in each. If set to 'none': 1,000,000,000. If set to 'e': 1e+9. If set to 'E': 1E+9. If set to 'power': 1x10^9 (where the 9 will appear super-scripted). If set to 'SI': 1G. If set to 'B': 1B (useful when referring to currency).

exponentformat()
Signature: unit -> unit

Sets how exponents show up. Here's how the number 1000000000 (1 billion) shows up in each. If set to 'none': 1,000,000,000. If set to 'e': 1e+9. If set to 'E': 1E+9. If set to 'power': 1x10^9 (where the 9 will appear super-scripted). If set to 'SI': 1G. If set to 'B': 1B (useful when referring to currency).

len()
Signature: unit -> float

Sets the length of the colorbar.

len()
Signature: unit -> unit

Sets the length of the colorbar.

lenmode()
Signature: unit -> string

Sets length unit mode.

lenmode()
Signature: unit -> unit

Sets length unit mode.

nticks()
Signature: unit -> float

Sets the number of colorbar ticks. No need to set 'autoticks' to FALSE for 'nticks' to apply.

nticks()
Signature: unit -> unit

Sets the number of colorbar ticks. No need to set 'autoticks' to FALSE for 'nticks' to apply.

outlinecolor()
Signature: unit -> string

The color of the outline surrounding this colorbar.

outlinecolor()
Signature: unit -> unit

The color of the outline surrounding this colorbar.

outlinewidth()
Signature: unit -> float

Sets the width of the outline surrounding this colorbar.

outlinewidth()
Signature: unit -> unit

Sets the width of the outline surrounding this colorbar.

ShouldSerializeautotick()
Signature: unit -> bool
ShouldSerializebgcolor()
Signature: unit -> bool
ShouldSerializebordercolor()
Signature: unit -> bool
ShouldSerializeborderwidth()
Signature: unit -> bool
ShouldSerializedtick()
Signature: unit -> bool
ShouldSerializeexponentformat()
Signature: unit -> bool
ShouldSerializelen()
Signature: unit -> bool
ShouldSerializelenmode()
Signature: unit -> bool
ShouldSerializenticks()
Signature: unit -> bool
ShouldSerializeoutlinecolor()
Signature: unit -> bool
ShouldSerializeoutlinewidth()
Signature: unit -> bool
ShouldSerializeshowexponent()
Signature: unit -> bool
ShouldSerializeshowticklabels()
Signature: unit -> bool
ShouldSerializethickness()
Signature: unit -> bool
ShouldSerializethicknessmode()
Signature: unit -> bool
ShouldSerializetick0()
Signature: unit -> bool
ShouldSerializetickangle()
Signature: unit -> bool
ShouldSerializetickcolor()
Signature: unit -> bool
ShouldSerializetickfont()
Signature: unit -> bool
ShouldSerializeticklen()
Signature: unit -> bool
ShouldSerializeticks()
Signature: unit -> bool
ShouldSerializetickwidth()
Signature: unit -> bool
ShouldSerializetitle()
Signature: unit -> bool
ShouldSerializetitlefont()
Signature: unit -> bool
ShouldSerializetitleside()
Signature: unit -> bool
ShouldSerializex()
Signature: unit -> bool
ShouldSerializexanchor()
Signature: unit -> bool
ShouldSerializexpad()
Signature: unit -> bool
ShouldSerializey()
Signature: unit -> bool
ShouldSerializeyanchor()
Signature: unit -> bool
ShouldSerializeypad()
Signature: unit -> bool
showexponent()
Signature: unit -> string

If set to 'all', ALL exponents will be shown appended to their significands. If set to 'first', the first tick's exponent will be appended to its significand, however no other exponents will appear--only the significands. If set to 'last', the last tick's exponent will be appended to its significand, however no other exponents will appear--only the significands. If set to 'none', no exponents will appear, only the significands.

showexponent()
Signature: unit -> unit

If set to 'all', ALL exponents will be shown appended to their significands. If set to 'first', the first tick's exponent will be appended to its significand, however no other exponents will appear--only the significands. If set to 'last', the last tick's exponent will be appended to its significand, however no other exponents will appear--only the significands. If set to 'none', no exponents will appear, only the significands.

showticklabels()
Signature: unit -> bool

Toggle whether or not the colorbar ticks will feature tick labels.

showticklabels()
Signature: unit -> unit

Toggle whether or not the colorbar ticks will feature tick labels.

thickness()
Signature: unit -> float

Sets the thickness of the line surrounding the colorbar.

thickness()
Signature: unit -> unit

Sets the thickness of the line surrounding the colorbar.

thicknessmode()
Signature: unit -> string

Sets thickness unit mode.

thicknessmode()
Signature: unit -> unit

Sets thickness unit mode.

tick0()
Signature: unit -> float

Sets the starting point of the ticks of this colorbar.

tick0()
Signature: unit -> unit

Sets the starting point of the ticks of this colorbar.

tickangle()
Signature: unit -> float

Sets the angle in degrees of the ticks on this colorbar.

tickangle()
Signature: unit -> unit

Sets the angle in degrees of the ticks on this colorbar.

tickcolor()
Signature: unit -> string

Sets the color of the tick lines on this colorbar.

tickcolor()
Signature: unit -> unit

Sets the color of the tick lines on this colorbar.

tickfont()
Signature: unit -> Font

Links a dictionary defining the parameters of the ticks' font.

tickfont()
Signature: unit -> unit

Links a dictionary defining the parameters of the ticks' font.

ticklen()
Signature: unit -> float

Sets the length of the tick lines on this colorbar.

ticklen()
Signature: unit -> unit

Sets the length of the tick lines on this colorbar.

ticks()
Signature: unit -> string

Sets the format of the ticks on this colorbar. For hidden ticks, link 'ticks' to an empty string.

ticks()
Signature: unit -> unit

Sets the format of the ticks on this colorbar. For hidden ticks, link 'ticks' to an empty string.

tickwidth()
Signature: unit -> float

Sets the width of the tick lines on this colorbar.

tickwidth()
Signature: unit -> unit

Sets the width of the tick lines on this colorbar.

title()
Signature: unit -> string

The title of the colorbar.

title()
Signature: unit -> unit

The title of the colorbar.

titlefont()
Signature: unit -> Font

Links a dictionary describing the font settings of the colorbar title.

titlefont()
Signature: unit -> unit

Links a dictionary describing the font settings of the colorbar title.

titleside()
Signature: unit -> string

Location of colorbar title with respect to the colorbar.

titleside()
Signature: unit -> unit

Location of colorbar title with respect to the colorbar.

x()
Signature: unit -> float

Sets the 'x' position of this colorbar.

x()
Signature: unit -> unit

Sets the 'x' position of this colorbar.

xanchor()
Signature: unit -> string

Sets the horizontal position anchor of this colorbar. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this colorbar.

xanchor()
Signature: unit -> unit

Sets the horizontal position anchor of this colorbar. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this colorbar.

xpad()
Signature: unit -> float

Sets the amount of space (padding) between the colorbar and the enclosing boarder in the x-direction.

xpad()
Signature: unit -> unit

Sets the amount of space (padding) between the colorbar and the enclosing boarder in the x-direction.

y()
Signature: unit -> float

Sets the 'y' position of this colorbar.

y()
Signature: unit -> unit

Sets the 'y' position of this colorbar.

yanchor()
Signature: unit -> string

Sets the vertical position anchor of this colorbar. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this colorbar.

yanchor()
Signature: unit -> unit

Sets the vertical position anchor of this colorbar. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this colorbar.

ypad()
Signature: unit -> float

Sets the amount of space (padding) between the colorbar and the enclosing boarder in the y-direction.

ypad()
Signature: unit -> unit

Sets the amount of space (padding) between the colorbar and the enclosing boarder in the y-direction.

Fork me on GitHub