XPlot


Colorbar Type

Namespace: XPlot.Plotly

Assembly: XPlot.Plotly.dll

Base Type: obj

Constructors

Constructor Description

Colorbar()

Full Usage: Colorbar()

Returns: Colorbar

Returns: Colorbar

Instance members

Instance member Description

this.ShouldSerializebgcolor()

Full Usage: this.ShouldSerializebgcolor()

Returns: bool

Returns: bool

this.ShouldSerializebordercolor()

Full Usage: this.ShouldSerializebordercolor()

Returns: bool

Returns: bool

this.ShouldSerializeborderwidth()

Full Usage: this.ShouldSerializeborderwidth()

Returns: bool

Returns: bool

this.ShouldSerializedtick()

Full Usage: this.ShouldSerializedtick()

Returns: bool

Returns: bool

this.ShouldSerializeexponentformat()

Full Usage: this.ShouldSerializeexponentformat()

Returns: bool

Returns: bool

this.ShouldSerializelen()

Full Usage: this.ShouldSerializelen()

Returns: bool

Returns: bool

this.ShouldSerializelenmode()

Full Usage: this.ShouldSerializelenmode()

Returns: bool

Returns: bool

this.ShouldSerializenticks()

Full Usage: this.ShouldSerializenticks()

Returns: bool

Returns: bool

this.ShouldSerializeoutlinecolor()

Full Usage: this.ShouldSerializeoutlinecolor()

Returns: bool

Returns: bool

this.ShouldSerializeoutlinewidth()

Full Usage: this.ShouldSerializeoutlinewidth()

Returns: bool

Returns: bool

this.ShouldSerializeshowexponent()

Full Usage: this.ShouldSerializeshowexponent()

Returns: bool

Returns: bool

this.ShouldSerializeshowticklabels()

Full Usage: this.ShouldSerializeshowticklabels()

Returns: bool

Returns: bool

this.ShouldSerializeshowtickprefix()

Full Usage: this.ShouldSerializeshowtickprefix()

Returns: bool

Returns: bool

this.ShouldSerializeshowticksuffix()

Full Usage: this.ShouldSerializeshowticksuffix()

Returns: bool

Returns: bool

this.ShouldSerializethickness()

Full Usage: this.ShouldSerializethickness()

Returns: bool

Returns: bool

this.ShouldSerializethicknessmode()

Full Usage: this.ShouldSerializethicknessmode()

Returns: bool

Returns: bool

this.ShouldSerializetick0()

Full Usage: this.ShouldSerializetick0()

Returns: bool

Returns: bool

this.ShouldSerializetickangle()

Full Usage: this.ShouldSerializetickangle()

Returns: bool

Returns: bool

this.ShouldSerializetickcolor()

Full Usage: this.ShouldSerializetickcolor()

Returns: bool

Returns: bool

this.ShouldSerializetickfont()

Full Usage: this.ShouldSerializetickfont()

Returns: bool

Returns: bool

this.ShouldSerializetickformat()

Full Usage: this.ShouldSerializetickformat()

Returns: bool

Returns: bool

this.ShouldSerializeticklen()

Full Usage: this.ShouldSerializeticklen()

Returns: bool

Returns: bool

this.ShouldSerializetickmode()

Full Usage: this.ShouldSerializetickmode()

Returns: bool

Returns: bool

this.ShouldSerializetickprefix()

Full Usage: this.ShouldSerializetickprefix()

Returns: bool

Returns: bool

this.ShouldSerializeticks()

Full Usage: this.ShouldSerializeticks()

Returns: bool

Returns: bool

this.ShouldSerializeticksuffix()

Full Usage: this.ShouldSerializeticksuffix()

Returns: bool

Returns: bool

this.ShouldSerializeticktext()

Full Usage: this.ShouldSerializeticktext()

Returns: bool

Returns: bool

this.ShouldSerializeticktextsrc()

Full Usage: this.ShouldSerializeticktextsrc()

Returns: bool

Returns: bool

this.ShouldSerializetickvals()

Full Usage: this.ShouldSerializetickvals()

Returns: bool

Returns: bool

this.ShouldSerializetickvalssrc()

Full Usage: this.ShouldSerializetickvalssrc()

Returns: bool

Returns: bool

this.ShouldSerializetickwidth()

Full Usage: this.ShouldSerializetickwidth()

Returns: bool

Returns: bool

this.ShouldSerializetitle()

Full Usage: this.ShouldSerializetitle()

Returns: bool

Returns: bool

this.ShouldSerializetitlefont()

Full Usage: this.ShouldSerializetitlefont()

Returns: bool

Returns: bool

this.ShouldSerializetitleside()

Full Usage: this.ShouldSerializetitleside()

Returns: bool

Returns: bool

this.ShouldSerializex()

Full Usage: this.ShouldSerializex()

Returns: bool

Returns: bool

this.ShouldSerializexanchor()

Full Usage: this.ShouldSerializexanchor()

Returns: bool

Returns: bool

this.ShouldSerializexpad()

Full Usage: this.ShouldSerializexpad()

Returns: bool

Returns: bool

this.ShouldSerializey()

Full Usage: this.ShouldSerializey()

Returns: bool

Returns: bool

this.ShouldSerializeyanchor()

Full Usage: this.ShouldSerializeyanchor()

Returns: bool

Returns: bool

this.ShouldSerializeypad()

Full Usage: this.ShouldSerializeypad()

Returns: bool

Returns: bool

this.bgcolor

Full Usage: this.bgcolor

Sets the color of padded area.

this.bordercolor

Full Usage: this.bordercolor

Sets the axis line color.

this.borderwidth

Full Usage: this.borderwidth

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

this.dtick

Full Usage: this.dtick

Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) 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.

this.exponentformat

Full Usage: this.exponentformat

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.

this.len

Full Usage: this.len

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.

this.lenmode

Full Usage: this.lenmode

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.

this.nticks

Full Usage: this.nticks

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

this.outlinecolor

Full Usage: this.outlinecolor

Sets the axis line color.

this.outlinewidth

Full Usage: this.outlinewidth

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

this.showexponent

Full Usage: this.showexponent

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.

this.showticklabels

Full Usage: this.showticklabels

Determines whether or not the tick labels are drawn.

this.showtickprefix

Full Usage: this.showtickprefix

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.

this.showticksuffix

Full Usage: this.showticksuffix

Same as `showtickprefix` but for tick suffixes.

this.thickness

Full Usage: this.thickness

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

this.thicknessmode

Full Usage: this.thicknessmode

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.

this.tick0

Full Usage: this.tick0

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.

this.tickangle

Full Usage: this.tickangle

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

this.tickcolor

Full Usage: this.tickcolor

Sets the tick color.

this.tickfont

Full Usage: this.tickfont

this.tickformat

Full Usage: this.tickformat

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.

this.ticklen

Full Usage: this.ticklen

Sets the tick length (in px).

this.tickmode

Full Usage: this.tickmode

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).

this.tickprefix

Full Usage: this.tickprefix

Sets a tick label prefix.

this.ticks

Full Usage: this.ticks

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.

this.ticksuffix

Full Usage: this.ticksuffix

Sets a tick label suffix.

this.ticktext

Full Usage: this.ticktext

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

this.ticktextsrc

Full Usage: this.ticktextsrc

Sets the source reference on plot.ly for ticktext .

this.tickvals

Full Usage: this.tickvals

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

this.tickvalssrc

Full Usage: this.tickvalssrc

Sets the source reference on plot.ly for tickvals .

this.tickwidth

Full Usage: this.tickwidth

Sets the tick width (in px).

this.title

Full Usage: this.title

Sets the title of the color bar.

this.titlefont

Full Usage: this.titlefont

this.titleside

Full Usage: this.titleside

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

this.x

Full Usage: this.x

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

this.xanchor

Full Usage: this.xanchor

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

this.xpad

Full Usage: this.xpad

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

this.y

Full Usage: this.y

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

this.yanchor

Full Usage: this.yanchor

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

this.ypad

Full Usage: this.ypad

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