ColorBar Type
The ColorBar object to be used with ColorAxes.
Constructors
Constructor | Description |
|
|
Static members
Static member | Description |
Full Usage:
ColorBar.init (?BGColor, ?BorderColor, ?BorderWidth, ?DTick, ?ExponentFormat, ?LabelAlias, ?Len, ?LenMode, ?MinExponent, ?NTicks, ?Orientation, ?OutlineColor, ?OutlineWidth, ?SeparateThousands, ?ShowExponent, ?ShowTickLabels, ?ShowTickPrefix, ?ShowTickSuffix, ?Thickness, ?ThicknessMode, ?Tick0, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickFormatStops, ?TickLabelOverflow, ?TickLabelPosition, ?TickLabelStep, ?TickLen, ?TickMode, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickText, ?TickVals, ?TickWidth, ?Title, ?X, ?XAnchor, ?XPad, ?XRef, ?Y, ?YAnchor, ?YPad, ?YRef)
Parameters:
Color
-
Sets the color of padded area.
?BorderColor : Color
-
Sets the axis line color.
?BorderWidth : float
-
Sets the width (in px) or the border enclosing this color bar.
?DTick : IConvertible
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. 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. "log" has several special values; "L?ExponentFormat : 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.
?LabelAlias : DynamicObj
-
Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
?Len : 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.
?LenMode : UnitMode
-
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.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Orientation : Orientation
-
Sets the orientation of the colorbar.
?OutlineColor : Color
-
Sets the axis line color.
?OutlineWidth : float
-
Sets the width (in px) of the axis line.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?ShowExponent : 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.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?ShowTickPrefix : ShowTickOption
-
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.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?Thickness : float
-
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
?ThicknessMode : UnitMode
-
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.
?Tick0 : IConvertible
-
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) except when `dtick`="L>f<" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
?TickAngle : int
-
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
?TickColor : Color
-
Sets the tick color.
?TickFont : Font
-
Sets the color bar's tick label font
?TickFormat : string
-
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn.
?TickLabelStep : int
-
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
?TickLen : float
-
Sets the tick length (in px).
?TickMode : 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).
?TickPrefix : string
-
Sets a tick label prefix.
?Ticks : TickOptions
-
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.
?TickSuffix : string
-
Sets a tick label suffix.
?TickText : 'a seq
-
Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
?TickVals : 'b seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
?TickWidth : float
-
Sets the tick width (in px).
?Title : Title
-
Sets the ColorBar title.
?X : float
-
Sets the x position of the color bar (in plot fraction).
?XAnchor : HorizontalAlign
-
Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the color bar.
?XPad : float
-
Sets the amount of padding (in px) along the x direction.
?XRef : string
-
Sets the container `x` refers to. "container" spans the entire `width` of the plot. "paper" refers to the width of the plotting area only.
?Y : float
-
Sets the y position of the color bar (in plot fraction).
?YAnchor : VerticalAlign
-
Sets this color bar's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the color bar.
?YPad : float
-
Sets the amount of padding (in px) along the y direction.
?YRef : string
-
Sets the container `y` refers to. "container" spans the entire `height` of the plot. "paper" refers to the height of the plotting area only.
Returns: ColorBar
|
|
Full Usage:
ColorBar.style (?BGColor, ?BorderColor, ?BorderWidth, ?DTick, ?ExponentFormat, ?LabelAlias, ?Len, ?LenMode, ?MinExponent, ?NTicks, ?Orientation, ?OutlineColor, ?OutlineWidth, ?SeparateThousands, ?ShowExponent, ?ShowTickLabels, ?ShowTickPrefix, ?ShowTickSuffix, ?Thickness, ?ThicknessMode, ?Tick0, ?TickAngle, ?TickColor, ?TickFont, ?TickFormat, ?TickFormatStops, ?TickLabelOverflow, ?TickLabelPosition, ?TickLabelStep, ?TickLen, ?TickMode, ?TickPrefix, ?Ticks, ?TickSuffix, ?TickText, ?TickVals, ?TickWidth, ?Title, ?X, ?XAnchor, ?XPad, ?XRef, ?Y, ?YAnchor, ?YPad, ?YRef)
Parameters:
Color
-
Sets the color of padded area.
?BorderColor : Color
-
Sets the axis line color.
?BorderWidth : float
-
Sets the width (in px) or the border enclosing this color bar.
?DTick : IConvertible
-
Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to "log" and "date" axes. 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. "log" has several special values; "L?ExponentFormat : 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.
?LabelAlias : DynamicObj
-
Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.
?Len : 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.
?LenMode : UnitMode
-
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.
?MinExponent : float
-
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is "SI" or "B".
?NTicks : int
-
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to "auto".
?Orientation : Orientation
-
Sets the orientation of the colorbar.
?OutlineColor : Color
-
Sets the axis line color.
?OutlineWidth : float
-
Sets the width (in px) of the axis line.
?SeparateThousands : bool
-
If "true", even 4-digit integers are separated
?ShowExponent : 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.
?ShowTickLabels : bool
-
Determines whether or not the tick labels are drawn.
?ShowTickPrefix : ShowTickOption
-
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.
?ShowTickSuffix : ShowTickOption
-
Same as `showtickprefix` but for tick suffixes.
?Thickness : float
-
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
?ThicknessMode : UnitMode
-
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.
?Tick0 : IConvertible
-
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) except when `dtick`="L>f<" (see `dtick` for more info). If the axis `type` is "date", it should be a date string, like date data. If the axis `type` is "category", it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.
?TickAngle : int
-
Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
?TickColor : Color
-
Sets the tick color.
?TickFont : Font
-
Sets the color bar's tick label font
?TickFormat : string
-
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: "%h" for half of the year as a decimal number as well as "%{n}f" for fractional seconds with n digits. For example, "2016-10-13 09:15:23.456" with tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
?TickFormatStops : TickFormatStop seq
-
Set rules for customizing TickFormat on different zoom levels
?TickLabelOverflow : TickLabelOverflow
-
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is "hide past domain". In other cases the default is "hide past div".
?TickLabelPosition : TickLabelPosition
-
Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.
?TickLabelStep : int
-
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` "log" or "multicategory", or when `tickmode` is "array".
?TickLen : float
-
Sets the tick length (in px).
?TickMode : 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).
?TickPrefix : string
-
Sets a tick label prefix.
?Ticks : TickOptions
-
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.
?TickSuffix : string
-
Sets a tick label suffix.
?TickText : 'a seq
-
Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to "array". Used with `tickvals`.
?TickVals : 'b seq
-
Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to "array". Used with `ticktext`.
?TickWidth : float
-
Sets the tick width (in px).
?Title : Title
-
Sets the ColorBar title.
?X : float
-
Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*.
?XAnchor : HorizontalAlign
-
'Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center*, or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.
?XPad : float
-
Sets the amount of padding (in px) along the x direction.
?XRef : string
?Y : float
-
Sets the y position of the color bar (in plot fraction).Defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*.'
?YAnchor : VerticalAlign
-
'Sets this color bar\'s vertical position anchor. This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar.Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.'
?YPad : float
-
Sets the amount of padding (in px) along the y direction.
?YRef : string
Returns: ColorBar -> ColorBar
|
|