Colorbar

Namespace: XPlot.Plotly
Parent Module: Graph

Constructors

Constructor	Description
`new()` Signature: unit -> Colorbar	CompiledName: `.ctor`

Instance members

Instance member	Description
`x.bgcolor()` Signature: unit -> string	Sets the color of padded area. CompiledName: `set_bgcolor`
`x.bgcolor()` Signature: unit -> unit	Sets the color of padded area. CompiledName: `get_bgcolor`
`x.bordercolor()` Signature: unit -> string	Sets the axis line color. CompiledName: `set_bordercolor`
`x.bordercolor()` Signature: unit -> unit	Sets the axis line color. CompiledName: `get_bordercolor`
`x.borderwidth()` Signature: unit -> float	Sets the width (in px) or the border enclosing this color bar. CompiledName: `set_borderwidth`
`x.borderwidth()` Signature: unit -> unit	Sets the width (in px) or the border enclosing this color bar. CompiledName: `get_borderwidth`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.nticks()` Signature: unit -> int	Sets the number of ticks. Has an effect only if `tickmode` is set to auto. CompiledName: `set_nticks`
`x.nticks()` Signature: unit -> unit	Sets the number of ticks. Has an effect only if `tickmode` is set to auto. CompiledName: `get_nticks`
`x.outlinecolor()` Signature: unit -> string	Sets the axis line color. CompiledName: `set_outlinecolor`
`x.outlinecolor()` Signature: unit -> unit	Sets the axis line color. CompiledName: `get_outlinecolor`
`x.outlinewidth()` Signature: unit -> float	Sets the width (in px) of the axis line. CompiledName: `set_outlinewidth`
`x.outlinewidth()` Signature: unit -> unit	Sets the width (in px) of the axis line. CompiledName: `get_outlinewidth`
`x.ShouldSerializebgcolor()` Signature: unit -> bool
`x.ShouldSerializebordercolor()` Signature: unit -> bool
`x.ShouldSerializeborderwidth()` Signature: unit -> bool
`x.ShouldSerializedtick()` Signature: unit -> bool
`x.ShouldSerializeexponentformat()` Signature: unit -> bool
`x.ShouldSerializelen()` Signature: unit -> bool
`x.ShouldSerializelenmode()` Signature: unit -> bool
`x.ShouldSerializenticks()` Signature: unit -> bool
`x.ShouldSerializeoutlinecolor()` Signature: unit -> bool
`x.ShouldSerializeoutlinewidth()` Signature: unit -> bool
`x.ShouldSerializeshowexponent()` Signature: unit -> bool
`x.ShouldSerializeshowticklabels()` Signature: unit -> bool
`x.ShouldSerializeshowtickprefix()` Signature: unit -> bool
`x.ShouldSerializeshowticksuffix()` Signature: unit -> bool
`x.ShouldSerializethickness()` Signature: unit -> bool
`x.ShouldSerializethicknessmode()` Signature: unit -> bool
`x.ShouldSerializetick0()` Signature: unit -> bool
`x.ShouldSerializetickangle()` Signature: unit -> bool
`x.ShouldSerializetickcolor()` Signature: unit -> bool
`x.ShouldSerializetickfont()` Signature: unit -> bool
`x.ShouldSerializetickformat()` Signature: unit -> bool
`x.ShouldSerializeticklen()` Signature: unit -> bool
`x.ShouldSerializetickmode()` Signature: unit -> bool
`x.ShouldSerializetickprefix()` Signature: unit -> bool
`x.ShouldSerializeticks()` Signature: unit -> bool
`x.ShouldSerializeticksuffix()` Signature: unit -> bool
`x.ShouldSerializeticktext()` Signature: unit -> bool
`x.ShouldSerializeticktextsrc()` Signature: unit -> bool
`x.ShouldSerializetickvals()` Signature: unit -> bool
`x.ShouldSerializetickvalssrc()` Signature: unit -> bool
`x.ShouldSerializetickwidth()` Signature: unit -> bool
`x.ShouldSerializetitle()` Signature: unit -> bool
`x.ShouldSerializetitlefont()` Signature: unit -> bool
`x.ShouldSerializetitleside()` Signature: unit -> bool
`x.ShouldSerializex()` Signature: unit -> bool
`x.ShouldSerializexanchor()` Signature: unit -> bool
`x.ShouldSerializexpad()` Signature: unit -> bool
`x.ShouldSerializey()` Signature: unit -> bool
`x.ShouldSerializeyanchor()` Signature: unit -> bool
`x.ShouldSerializeypad()` Signature: unit -> bool
`x.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`
`x.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`
`x.showticklabels()` Signature: unit -> bool	Determines whether or not the tick labels are drawn. CompiledName: `set_showticklabels`
`x.showticklabels()` Signature: unit -> unit	Determines whether or not the tick labels are drawn. CompiledName: `get_showticklabels`
`x.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`
`x.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`
`x.showticksuffix()` Signature: unit -> obj	Same as `showtickprefix` but for tick suffixes. CompiledName: `set_showticksuffix`
`x.showticksuffix()` Signature: unit -> unit	Same as `showtickprefix` but for tick suffixes. CompiledName: `get_showticksuffix`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.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`
`x.tickcolor()` Signature: unit -> string	Sets the tick color. CompiledName: `set_tickcolor`
`x.tickcolor()` Signature: unit -> unit	Sets the tick color. CompiledName: `get_tickcolor`
`x.tickfont()` Signature: unit -> Font	CompiledName: `set_tickfont`
`x.tickfont()` Signature: unit -> unit	CompiledName: `get_tickfont`
`x.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`
`x.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`
`x.ticklen()` Signature: unit -> float	Sets the tick length (in px). CompiledName: `set_ticklen`
`x.ticklen()` Signature: unit -> unit	Sets the tick length (in px). CompiledName: `get_ticklen`
`x.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`
`x.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`
`x.tickprefix()` Signature: unit -> string	Sets a tick label prefix. CompiledName: `set_tickprefix`
`x.tickprefix()` Signature: unit -> unit	Sets a tick label prefix. CompiledName: `get_tickprefix`
`x.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`
`x.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`
`x.ticksuffix()` Signature: unit -> string	Sets a tick label suffix. CompiledName: `set_ticksuffix`
`x.ticksuffix()` Signature: unit -> unit	Sets a tick label suffix. CompiledName: `get_ticksuffix`
`x.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`
`x.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`
`x.ticktextsrc()` Signature: unit -> string	Sets the source reference on plot.ly for ticktext . CompiledName: `set_ticktextsrc`
`x.ticktextsrc()` Signature: unit -> unit	Sets the source reference on plot.ly for ticktext . CompiledName: `get_ticktextsrc`
`x.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`
`x.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`
`x.tickvalssrc()` Signature: unit -> string	Sets the source reference on plot.ly for tickvals . CompiledName: `set_tickvalssrc`
`x.tickvalssrc()` Signature: unit -> unit	Sets the source reference on plot.ly for tickvals . CompiledName: `get_tickvalssrc`
`x.tickwidth()` Signature: unit -> float	Sets the tick width (in px). CompiledName: `set_tickwidth`
`x.tickwidth()` Signature: unit -> unit	Sets the tick width (in px). CompiledName: `get_tickwidth`
`x.title()` Signature: unit -> string	Sets the title of the color bar. CompiledName: `set_title`
`x.title()` Signature: unit -> unit	Sets the title of the color bar. CompiledName: `get_title`
`x.titlefont()` Signature: unit -> Font	CompiledName: `set_titlefont`
`x.titlefont()` Signature: unit -> unit	CompiledName: `get_titlefont`
`x.titleside()` Signature: unit -> obj	Determines the location of the colorbar title with respect to the color bar. CompiledName: `set_titleside`
`x.titleside()` Signature: unit -> unit	Determines the location of the colorbar title with respect to the color bar. CompiledName: `get_titleside`
`x.x()` Signature: unit -> float	Sets the x position of the color bar (in plot fraction). CompiledName: `set_x`
`x.x()` Signature: unit -> unit	Sets the x position of the color bar (in plot fraction). CompiledName: `get_x`
`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`
`x.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`
`x.xpad()` Signature: unit -> float	Sets the amount of padding (in px) along the x direction. CompiledName: `set_xpad`
`x.xpad()` Signature: unit -> unit	Sets the amount of padding (in px) along the x direction. CompiledName: `get_xpad`
`x.y()` Signature: unit -> float	Sets the y position of the color bar (in plot fraction). CompiledName: `set_y`
`x.y()` Signature: unit -> unit	Sets the y position of the color bar (in plot fraction). CompiledName: `get_y`
`x.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`
`x.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`
`x.ypad()` Signature: unit -> float	Sets the amount of padding (in px) along the y direction. CompiledName: `set_ypad`
`x.ypad()` Signature: unit -> unit	Sets the amount of padding (in px) along the y direction. CompiledName: `get_ypad`