XPlot


Colorbar

Namespace: XPlot.Plotly
Parent Module: Graph

Constructors

ConstructorDescription
new()
Signature: unit -> Colorbar

CompiledName: .ctor

Instance members

Instance memberDescription
bgcolor()
Signature: unit -> string

Sets the color of padded area.

CompiledName: set_bgcolor

bgcolor()
Signature: unit -> unit

Sets the color of padded area.

CompiledName: get_bgcolor

bordercolor()
Signature: unit -> string

Sets the axis line color.

CompiledName: set_bordercolor

bordercolor()
Signature: unit -> unit

Sets the axis line color.

CompiledName: get_bordercolor

borderwidth()
Signature: unit -> float

Sets the width (in px) or the border enclosing this color bar.

CompiledName: set_borderwidth

borderwidth()
Signature: unit -> unit

Sets the width (in px) or the border enclosing this color bar.

CompiledName: get_borderwidth

dtick()
Signature: unit -> obj

Sets the step in-between ticks on this axis Use with tick0. If the axis type is log, then ticks are set every 10^(ndtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis type is date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0.

CompiledName: set_dtick

dtick()
Signature: unit -> unit

Sets the step in-between ticks on this axis Use with tick0. If the axis type is log, then ticks are set every 10^(ndtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis type is date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0.

CompiledName: get_dtick

exponentformat()
Signature: unit -> obj

Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If none, it appears as 1,000,000,000. If e, 1e+9. If E, 1E+9. If power, 1x10^9 (with 9 in a super script). If SI, 1G. If B, 1B.

CompiledName: set_exponentformat

exponentformat()
Signature: unit -> unit

Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If none, it appears as 1,000,000,000. If e, 1e+9. If E, 1E+9. If power, 1x10^9 (with 9 in a super script). If SI, 1G. If B, 1B.

CompiledName: get_exponentformat

len()
Signature: unit -> float

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

CompiledName: set_len

len()
Signature: unit -> unit

Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

CompiledName: get_len

lenmode()
Signature: unit -> obj

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

CompiledName: set_lenmode

lenmode()
Signature: unit -> unit

Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot fraction or in *pixels. Use len to set the value.

CompiledName: get_lenmode

nticks()
Signature: unit -> int

Sets the number of ticks. Has an effect only if tickmode is set to auto.

CompiledName: set_nticks

nticks()
Signature: unit -> unit

Sets the number of ticks. Has an effect only if tickmode is set to auto.

CompiledName: get_nticks

outlinecolor()
Signature: unit -> string

Sets the axis line color.

CompiledName: set_outlinecolor

outlinecolor()
Signature: unit -> unit

Sets the axis line color.

CompiledName: get_outlinecolor

outlinewidth()
Signature: unit -> float

Sets the width (in px) of the axis line.

CompiledName: set_outlinewidth

outlinewidth()
Signature: unit -> unit

Sets the width (in px) of the axis line.

CompiledName: get_outlinewidth

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
ShouldSerializeshowtickprefix()
Signature: unit -> bool
ShouldSerializeshowticksuffix()
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
ShouldSerializetickformat()
Signature: unit -> bool
ShouldSerializeticklen()
Signature: unit -> bool
ShouldSerializetickmode()
Signature: unit -> bool
ShouldSerializetickprefix()
Signature: unit -> bool
ShouldSerializeticks()
Signature: unit -> bool
ShouldSerializeticksuffix()
Signature: unit -> bool
ShouldSerializeticktext()
Signature: unit -> bool
ShouldSerializeticktextsrc()
Signature: unit -> bool
ShouldSerializetickvals()
Signature: unit -> bool
ShouldSerializetickvalssrc()
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 -> obj

If all, all exponents are shown besides their significands. If first, only the exponent of the first tick is shown. If last, only the exponent of the last tick is shown. If none, no exponents appear.

CompiledName: set_showexponent

showexponent()
Signature: unit -> unit

If all, all exponents are shown besides their significands. If first, only the exponent of the first tick is shown. If last, only the exponent of the last tick is shown. If none, no exponents appear.

CompiledName: get_showexponent

showticklabels()
Signature: unit -> bool

Determines whether or not the tick labels are drawn.

CompiledName: set_showticklabels

showticklabels()
Signature: unit -> unit

Determines whether or not the tick labels are drawn.

CompiledName: get_showticklabels

showtickprefix()
Signature: unit -> obj

If all, all tick labels are displayed with a prefix. If first, only the first tick is displayed with a prefix. If last, only the last tick is displayed with a suffix. If none, tick prefixes are hidden.

CompiledName: set_showtickprefix

showtickprefix()
Signature: unit -> unit

If all, all tick labels are displayed with a prefix. If first, only the first tick is displayed with a prefix. If last, only the last tick is displayed with a suffix. If none, tick prefixes are hidden.

CompiledName: get_showtickprefix

showticksuffix()
Signature: unit -> obj

Same as showtickprefix but for tick suffixes.

CompiledName: set_showticksuffix

showticksuffix()
Signature: unit -> unit

Same as showtickprefix but for tick suffixes.

CompiledName: get_showticksuffix

thickness()
Signature: unit -> float

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

CompiledName: set_thickness

thickness()
Signature: unit -> unit

Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

CompiledName: get_thickness

thicknessmode()
Signature: unit -> obj

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

CompiledName: set_thicknessmode

thicknessmode()
Signature: unit -> unit

Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot fraction or in pixels. Use thickness to set the value.

CompiledName: get_thicknessmode

tick0()
Signature: unit -> float

Sets the placement of the first tick on this axis. Use with dtick. If the axis type is log, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2). If the axis type is date, then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.

CompiledName: set_tick0

tick0()
Signature: unit -> unit

Sets the placement of the first tick on this axis. Use with dtick. If the axis type is log, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2). If the axis type is date, then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.

CompiledName: get_tick0

tickangle()
Signature: unit -> float

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

CompiledName: set_tickangle

tickangle()
Signature: unit -> unit

Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

CompiledName: get_tickangle

tickcolor()
Signature: unit -> string

Sets the tick color.

CompiledName: set_tickcolor

tickcolor()
Signature: unit -> unit

Sets the tick color.

CompiledName: get_tickcolor

tickfont()
Signature: unit -> Font

CompiledName: set_tickfont

tickfont()
Signature: unit -> unit

CompiledName: get_tickfont

tickformat()
Signature: unit -> string

Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.

CompiledName: set_tickformat

tickformat()
Signature: unit -> unit

Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.

CompiledName: get_tickformat

ticklen()
Signature: unit -> float

Sets the tick length (in px).

CompiledName: set_ticklen

ticklen()
Signature: unit -> unit

Sets the tick length (in px).

CompiledName: get_ticklen

tickmode()
Signature: unit -> obj

Sets the tick mode for this axis. If auto, the number of ticks is set via nticks. If linear, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (linear is the default value if tick0 and dtick are provided). If array, the placement of the ticks is set via tickvals and the tick text is ticktext. (array is the default value if tickvals is provided).

CompiledName: set_tickmode

tickmode()
Signature: unit -> unit

Sets the tick mode for this axis. If auto, the number of ticks is set via nticks. If linear, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (linear is the default value if tick0 and dtick are provided). If array, the placement of the ticks is set via tickvals and the tick text is ticktext. (array is the default value if tickvals is provided).

CompiledName: get_tickmode

tickprefix()
Signature: unit -> string

Sets a tick label prefix.

CompiledName: set_tickprefix

tickprefix()
Signature: unit -> unit

Sets a tick label prefix.

CompiledName: get_tickprefix

ticks()
Signature: unit -> obj

Determines whether ticks are drawn or not. If , this axis' ticks are not drawn. If outside (inside), this axis' are drawn outside (inside) the axis lines.

CompiledName: set_ticks

ticks()
Signature: unit -> unit

Determines whether ticks are drawn or not. If , this axis' ticks are not drawn. If outside (inside), this axis' are drawn outside (inside) the axis lines.

CompiledName: get_ticks

ticksuffix()
Signature: unit -> string

Sets a tick label suffix.

CompiledName: set_ticksuffix

ticksuffix()
Signature: unit -> unit

Sets a tick label suffix.

CompiledName: get_ticksuffix

ticktext()
Signature: unit -> obj

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with ticktext.

CompiledName: set_ticktext

ticktext()
Signature: unit -> unit

Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to array. Used with ticktext.

CompiledName: get_ticktext

ticktextsrc()
Signature: unit -> string

Sets the source reference on plot.ly for ticktext .

CompiledName: set_ticktextsrc

ticktextsrc()
Signature: unit -> unit

Sets the source reference on plot.ly for ticktext .

CompiledName: get_ticktextsrc

tickvals()
Signature: unit -> obj

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

CompiledName: set_tickvals

tickvals()
Signature: unit -> unit

Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to array. Used with ticktext.

CompiledName: get_tickvals

tickvalssrc()
Signature: unit -> string

Sets the source reference on plot.ly for tickvals .

CompiledName: set_tickvalssrc

tickvalssrc()
Signature: unit -> unit

Sets the source reference on plot.ly for tickvals .

CompiledName: get_tickvalssrc

tickwidth()
Signature: unit -> float

Sets the tick width (in px).

CompiledName: set_tickwidth

tickwidth()
Signature: unit -> unit

Sets the tick width (in px).

CompiledName: get_tickwidth

title()
Signature: unit -> string

Sets the title of the color bar.

CompiledName: set_title

title()
Signature: unit -> unit

Sets the title of the color bar.

CompiledName: get_title

titlefont()
Signature: unit -> Font

CompiledName: set_titlefont

titlefont()
Signature: unit -> unit

CompiledName: get_titlefont

titleside()
Signature: unit -> obj

Determines the location of the colorbar title with respect to the color bar.

CompiledName: set_titleside

titleside()
Signature: unit -> unit

Determines the location of the colorbar title with respect to the color bar.

CompiledName: get_titleside

x()
Signature: unit -> float

Sets the x position of the color bar (in plot fraction).

CompiledName: set_x

x()
Signature: unit -> unit

Sets the x position of the color bar (in plot fraction).

CompiledName: get_x

xanchor()
Signature: unit -> obj

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar.

CompiledName: set_xanchor

xanchor()
Signature: unit -> unit

Sets this color bar's horizontal position anchor. This anchor binds the x position to the left, center or right of the color bar.

CompiledName: get_xanchor

xpad()
Signature: unit -> float

Sets the amount of padding (in px) along the x direction.

CompiledName: set_xpad

xpad()
Signature: unit -> unit

Sets the amount of padding (in px) along the x direction.

CompiledName: get_xpad

y()
Signature: unit -> float

Sets the y position of the color bar (in plot fraction).

CompiledName: set_y

y()
Signature: unit -> unit

Sets the y position of the color bar (in plot fraction).

CompiledName: get_y

yanchor()
Signature: unit -> obj

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar.

CompiledName: set_yanchor

yanchor()
Signature: unit -> unit

Sets this color bar's vertical position anchor This anchor binds the y position to the top, middle or bottom of the color bar.

CompiledName: get_yanchor

ypad()
Signature: unit -> float

Sets the amount of padding (in px) along the y direction.

CompiledName: set_ypad

ypad()
Signature: unit -> unit

Sets the amount of padding (in px) along the y direction.

CompiledName: get_ypad

Fork me on GitHub