XPlot


Xaxis

Namespace: XPlot.Plotly
Parent Module: Graph

Constructors

ConstructorDescription
new()
Signature: unit -> Xaxis

CompiledName: .ctor

Instance members

Instance memberDescription
_isSubplotObj()
Signature: unit -> bool

CompiledName: set__isSubplotObj

_isSubplotObj()
Signature: unit -> unit

CompiledName: get__isSubplotObj

anchor()
Signature: unit -> obj

If set to an opposite-letter axis id (e.g. xaxis2, yaxis), this axis is bound to the corresponding opposite-letter axis. If set to free, this axis' position is determined by position.

CompiledName: set_anchor

anchor()
Signature: unit -> unit

If set to an opposite-letter axis id (e.g. xaxis2, yaxis), this axis is bound to the corresponding opposite-letter axis. If set to free, this axis' position is determined by position.

CompiledName: get_anchor

autorange()
Signature: unit -> obj

Determines whether or not the range of this axis is computed in relation to the input data. See rangemode for more info. If range is provided, then autorange is set to false.

CompiledName: set_autorange

autorange()
Signature: unit -> unit

Determines whether or not the range of this axis is computed in relation to the input data. See rangemode for more info. If range is provided, then autorange is set to false.

CompiledName: get_autorange

autotick()
Signature: unit -> bool

CompiledName: set_autotick

autotick()
Signature: unit -> unit

CompiledName: get_autotick

backgroundcolor()
Signature: unit -> string

Sets the background color of this axis' wall.

CompiledName: set_backgroundcolor

backgroundcolor()
Signature: unit -> unit

Sets the background color of this axis' wall.

CompiledName: get_backgroundcolor

domain()
Signature: unit -> obj

Sets the domain of this axis (in plot fraction).

CompiledName: set_domain

domain()
Signature: unit -> unit

Sets the domain of this axis (in plot fraction).

CompiledName: get_domain

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

fixedrange()
Signature: unit -> bool

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

CompiledName: set_fixedrange

fixedrange()
Signature: unit -> unit

Determines whether or not this axis is zoom-able. If true, then zoom is disabled.

CompiledName: get_fixedrange

gridcolor()
Signature: unit -> string

Sets the color of the grid lines.

CompiledName: set_gridcolor

gridcolor()
Signature: unit -> unit

Sets the color of the grid lines.

CompiledName: get_gridcolor

gridwidth()
Signature: unit -> float

Sets the width (in px) of the grid lines.

CompiledName: set_gridwidth

gridwidth()
Signature: unit -> unit

Sets the width (in px) of the grid lines.

CompiledName: get_gridwidth

hoverformat()
Signature: unit -> string

Sets the hover text formatting rule for data values on this axis, 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_hoverformat

hoverformat()
Signature: unit -> unit

Sets the hover text formatting rule for data values on this axis, 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_hoverformat

linecolor()
Signature: unit -> string

Sets the axis line color.

CompiledName: set_linecolor

linecolor()
Signature: unit -> unit

Sets the axis line color.

CompiledName: get_linecolor

linewidth()
Signature: unit -> float

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

CompiledName: set_linewidth

linewidth()
Signature: unit -> unit

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

CompiledName: get_linewidth

mirror()
Signature: unit -> obj

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

CompiledName: set_mirror

mirror()
Signature: unit -> unit

Determines if the axis lines or/and ticks are mirrored to the opposite side of the plotting area. If true, the axis lines are mirrored. If ticks, the axis lines and ticks are mirrored. If false, mirroring is disable. If all, axis lines are mirrored on all shared-axes subplots. If allticks, axis lines and ticks are mirrored on all shared-axes subplots.

CompiledName: get_mirror

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

overlaying()
Signature: unit -> obj

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If false, this axis does not overlay any same-letter axes.

CompiledName: set_overlaying

overlaying()
Signature: unit -> unit

If set a same-letter axis id, this axis is overlaid on top of the corresponding same-letter axis. If false, this axis does not overlay any same-letter axes.

CompiledName: get_overlaying

position()
Signature: unit -> float

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

CompiledName: set_position

position()
Signature: unit -> unit

Sets the position of this axis in the plotting space (in normalized coordinates). Only has an effect if anchor is set to free.

CompiledName: get_position

range()
Signature: unit -> obj

Sets the range of this axis. If the axis type is log, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 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 date range from January 1st 1970 to November 4th, 2013, set the range from 0 to 1380844800000.0

CompiledName: set_range

range()
Signature: unit -> unit

Sets the range of this axis. If the axis type is log, then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 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 date range from January 1st 1970 to November 4th, 2013, set the range from 0 to 1380844800000.0

CompiledName: get_range

rangemode()
Signature: unit -> obj

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data.

CompiledName: set_rangemode

rangemode()
Signature: unit -> unit

If normal, the range is computed in relation to the extrema of the input data. If tozero`, the range extends to 0, regardless of the input data If nonnegative, the range is non-negative, regardless of the input data.

CompiledName: get_rangemode

ShouldSerialize_isSubplotObj()
Signature: unit -> bool
ShouldSerializeanchor()
Signature: unit -> bool
ShouldSerializeautorange()
Signature: unit -> bool
ShouldSerializeautotick()
Signature: unit -> bool
ShouldSerializebackgroundcolor()
Signature: unit -> bool
ShouldSerializedomain()
Signature: unit -> bool
ShouldSerializedtick()
Signature: unit -> bool
ShouldSerializeexponentformat()
Signature: unit -> bool
ShouldSerializefixedrange()
Signature: unit -> bool
ShouldSerializegridcolor()
Signature: unit -> bool
ShouldSerializegridwidth()
Signature: unit -> bool
ShouldSerializehoverformat()
Signature: unit -> bool
ShouldSerializelinecolor()
Signature: unit -> bool
ShouldSerializelinewidth()
Signature: unit -> bool
ShouldSerializemirror()
Signature: unit -> bool
ShouldSerializenticks()
Signature: unit -> bool
ShouldSerializeoverlaying()
Signature: unit -> bool
ShouldSerializeposition()
Signature: unit -> bool
ShouldSerializerange()
Signature: unit -> bool
ShouldSerializerangemode()
Signature: unit -> bool
ShouldSerializeshowaxeslabels()
Signature: unit -> bool
ShouldSerializeshowbackground()
Signature: unit -> bool
ShouldSerializeshowexponent()
Signature: unit -> bool
ShouldSerializeshowgrid()
Signature: unit -> bool
ShouldSerializeshowline()
Signature: unit -> bool
ShouldSerializeshowspikes()
Signature: unit -> bool
ShouldSerializeshowticklabels()
Signature: unit -> bool
ShouldSerializeshowtickprefix()
Signature: unit -> bool
ShouldSerializeshowticksuffix()
Signature: unit -> bool
ShouldSerializeside()
Signature: unit -> bool
ShouldSerializespikecolor()
Signature: unit -> bool
ShouldSerializespikesides()
Signature: unit -> bool
ShouldSerializespikethickness()
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
ShouldSerializetype()
Signature: unit -> bool
ShouldSerializezeroline()
Signature: unit -> bool
ShouldSerializezerolinecolor()
Signature: unit -> bool
ShouldSerializezerolinewidth()
Signature: unit -> bool
showaxeslabels()
Signature: unit -> bool

Sets whether or not this axis is labeled

CompiledName: set_showaxeslabels

showaxeslabels()
Signature: unit -> unit

Sets whether or not this axis is labeled

CompiledName: get_showaxeslabels

showbackground()
Signature: unit -> bool

Sets whether or not this axis' wall has a background color.

CompiledName: set_showbackground

showbackground()
Signature: unit -> unit

Sets whether or not this axis' wall has a background color.

CompiledName: get_showbackground

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

showgrid()
Signature: unit -> bool

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

CompiledName: set_showgrid

showgrid()
Signature: unit -> unit

Determines whether or not grid lines are drawn. If true, the grid lines are drawn at every tick mark.

CompiledName: get_showgrid

showline()
Signature: unit -> bool

Determines whether or not a line bounding this axis is drawn.

CompiledName: set_showline

showline()
Signature: unit -> unit

Determines whether or not a line bounding this axis is drawn.

CompiledName: get_showline

showspikes()
Signature: unit -> bool

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

CompiledName: set_showspikes

showspikes()
Signature: unit -> unit

Sets whether or not spikes starting from data points to this axis' wall are shown on hover.

CompiledName: get_showspikes

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

side()
Signature: unit -> obj

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

CompiledName: set_side

side()
Signature: unit -> unit

Determines whether a x (y) axis is positioned at the bottom (left) or top (right) of the plotting area.

CompiledName: get_side

spikecolor()
Signature: unit -> string

Sets the color of the spikes.

CompiledName: set_spikecolor

spikecolor()
Signature: unit -> unit

Sets the color of the spikes.

CompiledName: get_spikecolor

spikesides()
Signature: unit -> bool

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

CompiledName: set_spikesides

spikesides()
Signature: unit -> unit

Sets whether or not spikes extending from the projection data points to this axis' wall boundaries are shown on hover.

CompiledName: get_spikesides

spikethickness()
Signature: unit -> float

Sets the thickness (in px) of the spikes.

CompiledName: set_spikethickness

spikethickness()
Signature: unit -> unit

Sets the thickness (in px) of the spikes.

CompiledName: get_spikethickness

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 this axis.

CompiledName: set_title

title()
Signature: unit -> unit

Sets the title of this axis.

CompiledName: get_title

titlefont()
Signature: unit -> Font

CompiledName: set_titlefont

titlefont()
Signature: unit -> unit

CompiledName: get_titlefont

type()
Signature: unit -> obj

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

CompiledName: set_type

type()
Signature: unit -> unit

Sets the axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.

CompiledName: get_type

zeroline()
Signature: unit -> bool

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

CompiledName: set_zeroline

zeroline()
Signature: unit -> unit

Determines whether or not a line is drawn at along the 0 value of this axis. If true, the zero line is drawn on top of the grid lines.

CompiledName: get_zeroline

zerolinecolor()
Signature: unit -> string

Sets the line color of the zero line.

CompiledName: set_zerolinecolor

zerolinecolor()
Signature: unit -> unit

Sets the line color of the zero line.

CompiledName: get_zerolinecolor

zerolinewidth()
Signature: unit -> float

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

CompiledName: set_zerolinewidth

zerolinewidth()
Signature: unit -> unit

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

CompiledName: get_zerolinewidth

Fork me on GitHub