Logo Plotly.NET

Trace2D Type

Namespace: Plotly.NET
Assembly: Plotly.NET.dll
Base Type: Trace
All Interfaces: IDynamicMetaObjectProvider

The most commonly-used kind of subplot is a two-dimensional Cartesian subplot. Traces compatible with these subplots support xaxis and yaxis attributes whose values must refer to corresponding objects in the layout portion of the figure. For example, if xaxis="x", and yaxis="y" (which is the default) then this trace is drawn on the subplot at the intersection of the axes configured under layout.xaxis and layout.yaxis, but if xaxis="x2" and yaxis="y3" then the trace is drawn at the intersection of the axes configured under layout.xaxis2 and layout.yaxis3. Note that attributes such as layout.xaxis and layout.xaxis2 etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of different types can be drawn on the same subplot. X- and Y-axes support the type attribute, which enables them to represent continuous values (type="linear", type="log"), temporal values (type="date") or categorical values (type="category", type="multicategory). Axes can also be overlaid on top of one another to create dual-axis or multiple-axis charts. 2-d cartesian subplots lend themselves very well to creating "small multiples" figures, also known as facet or trellis plots. The following trace types are compatible with 2D-cartesian subplots via the xaxis and yaxis attributes: - scatter-like trace types: scatter and scattergl can be used to draw scatter plots, line plots and curves, time-series plots, bubble charts, dot plots and filled areas and also support error bars - bar, funnel, waterfall: bar-like trace types which can also be used to draw timelines and Gantt charts - histogram: an aggregating bar-like trace type - box and violin: 1-dimensional distribution-like trace types - histogram2D and histogram2Dcontour: 2-dimensional distribution-like density trace types - image, heatmap and contour: matrix trace types - ohlc and candlestick: stock-like trace types - splom: multi-dimensional scatter plots which implicitly refer to many 2-d cartesian subplots at once.

Constructors

Constructor Description

Trace2D(traceTypeName)

Full Usage: Trace2D(traceTypeName)

Parameters:
    traceTypeName : string

Returns: Trace2D
traceTypeName : string
Returns: Trace2D

Static members

Static member Description

Trace2D.initBar applyStyle

Full Usage: Trace2D.initBar applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "bar" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initBoxPlot applyStyle

Full Usage: Trace2D.initBoxPlot applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "box" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initCandlestick applyStyle

Full Usage: Trace2D.initCandlestick applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "candlestick" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initContour applyStyle

Full Usage: Trace2D.initContour applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "contour" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initFunnel applyStyle

Full Usage: Trace2D.initFunnel applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "funnel" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initHeatmap applyStyle

Full Usage: Trace2D.initHeatmap applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "heatmap" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initHeatmapGL applyStyle

Full Usage: Trace2D.initHeatmapGL applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "heatmapgl" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initHistogram applyStyle

Full Usage: Trace2D.initHistogram applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "histogram" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initHistogram2D applyStyle

Full Usage: Trace2D.initHistogram2D applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "histogram2D" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initHistogram2DContour applyStyle

Full Usage: Trace2D.initHistogram2DContour applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "histogram2Dcontour" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initImage applyStyle

Full Usage: Trace2D.initImage applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "image" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initOHLC applyStyle

Full Usage: Trace2D.initOHLC applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "ohlc" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initScatter applyStyle

Full Usage: Trace2D.initScatter applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "scatter" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initScatterGL applyStyle

Full Usage: Trace2D.initScatterGL applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "scattergl" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initSplom applyStyle

Full Usage: Trace2D.initSplom applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "SPLOM" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initViolin applyStyle

Full Usage: Trace2D.initViolin applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "violin" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Trace2D.initWaterfall applyStyle

Full Usage: Trace2D.initWaterfall applyStyle

Parameters:
Returns: Trace2D

initializes a trace of type "waterfall" applying the given trace styling function

applyStyle : Trace2D -> Trace2D
Returns: Trace2D

Inherited members

Inherited from Trace

Instance members

Instance member Description

this.type

Full Usage: this.type

Returns: string
Returns: string

Static members

Static member Description

Trace.getColorAxisAnchor trace

Full Usage: Trace.getColorAxisAnchor trace

Parameters:
    trace : 'a - The trace to get the color axis anchor from

Returns: SubPlotId
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the color axis anchor of the given trace. If there is no color axis set, returns "coloraxis".

trace : 'a

The trace to get the color axis anchor from

Returns: SubPlotId

Trace.getColorBar trace

Full Usage: Trace.getColorBar trace

Parameters:
    trace : 'a - The trace to get the cdomain from

Returns: ColorBar
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the colorbar of the given trace. If there is no colorbar set, returns an empty ColorBar object.

trace : 'a

The trace to get the cdomain from

Returns: ColorBar

Trace.getDomain trace

Full Usage: Trace.getDomain trace

Parameters:
    trace : 'a - The trace to get the cdomain from

Returns: Domain
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the domain of the given trace. If there is no domain set, returns an empty Domain object.

trace : 'a

The trace to get the cdomain from

Returns: Domain

Trace.getLegendAnchor trace

Full Usage: Trace.getLegendAnchor trace

Parameters:
    trace : 'a - The trace to get the Legend anchor from

Returns: SubPlotId
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Legend anchor of the given trace. If there is no Legend set, returns "legend".

trace : 'a

The trace to get the Legend anchor from

Returns: SubPlotId

Trace.getLine trace

Full Usage: Trace.getLine trace

Parameters:
    trace : 'a - The trace to get the line from

Returns: Line
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Line object of the given trace. If there is no line set, returns an empty line object.

trace : 'a

The trace to get the line from

Returns: Line

Trace.getMarker trace

Full Usage: Trace.getMarker trace

Parameters:
    trace : 'a - The trace to get the marker from

Returns: Marker
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Marker object of the given trace. If there is no marker set, returns an empty marker object.

trace : 'a

The trace to get the marker from

Returns: Marker

Trace.getStackGroup trace

Full Usage: Trace.getStackGroup trace

Parameters:
    trace : 'a - The trace to get the stackgroup from

Returns: string
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the stackgroup of the given trace. If there is no stackgroup set, returns "stackgroup".

trace : 'a

The trace to get the stackgroup from

Returns: string

Trace.getXError trace

Full Usage: Trace.getXError trace

Parameters:
    trace : 'a - The trace to get the x error from

Returns: Error
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Error object for the x dimension of the given trace. If there is no error set, returns an empty error object.

trace : 'a

The trace to get the x error from

Returns: Error

Trace.getYError trace

Full Usage: Trace.getYError trace

Parameters:
    trace : 'a - The trace to get the y error from

Returns: Error
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Error object for the y dimension of the given trace. If there is no error set, returns an empty error object.

trace : 'a

The trace to get the y error from

Returns: Error

Trace.getZError trace

Full Usage: Trace.getZError trace

Parameters:
    trace : 'a - The trace to get the z error from

Returns: Error
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns the Error object for the z dimension of the given trace. If there is no error set, returns an empty error object.

trace : 'a

The trace to get the z error from

Returns: Error

Trace.setColorAxisAnchor colorAxisId

Full Usage: Trace.setColorAxisAnchor colorAxisId

Parameters:
    colorAxisId : int - The new color axis anchor

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the color axis anchor of the given trace.

colorAxisId : int

The new color axis anchor

Returns: 'a -> 'a

Trace.setColorBar colorBar

Full Usage: Trace.setColorBar colorBar

Parameters:
    colorBar : ColorBar - The new ColorBar

Returns: 'T -> 'T
Type parameters: 'T (requires :> Plotly.NET.Trace)

Returns a function that sets the ColorBar of the given trace.

colorBar : ColorBar

The new ColorBar

Returns: 'T -> 'T

Trace.setDomain domain

Full Usage: Trace.setDomain domain

Parameters:
    domain : Domain - The new domain

Returns: 'T -> 'T
Type parameters: 'T (requires :> Plotly.NET.Trace)

Returns a function that sets the domain of the given trace.

domain : Domain

The new domain

Returns: 'T -> 'T

Trace.setLegendAnchor legendId

Full Usage: Trace.setLegendAnchor legendId

Parameters:
    legendId : int - The new Legend anchor

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the Legend anchor of the given trace.

legendId : int

The new Legend anchor

Returns: 'a -> 'a

Trace.setLine line

Full Usage: Trace.setLine line

Parameters:
    line : Line - The new line object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the Line object of the given trace.

line : Line

The new line object

Returns: 'a -> 'a

Trace.setMarker marker

Full Usage: Trace.setMarker marker

Parameters:
    marker : Marker - The new marker object

Returns: 'T -> 'T
Type parameters: 'T (requires :> Plotly.NET.Trace)

Returns a function that sets the Marker object of the given trace.

marker : Marker

The new marker object

Returns: 'T -> 'T

Trace.setStackGroup stackgroup

Full Usage: Trace.setStackGroup stackgroup

Parameters:
    stackgroup : string - The new stackgroup

Returns: 'T -> 'T
Type parameters: 'T (requires :> Plotly.NET.Trace)

Returns a function that sets the stackgroup of the given trace.

stackgroup : string

The new stackgroup

Returns: 'T -> 'T

Trace.setXError error

Full Usage: Trace.setXError error

Parameters:
    error : Error - The new error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the Error object for the x dimension of the given trace.

error : Error

The new error object

Returns: 'a -> 'a

Trace.setYError error

Full Usage: Trace.setYError error

Parameters:
    error : Error - The new error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the Error object for the x dimension of the given trace.

error : Error

The new error object

Returns: 'a -> 'a

Trace.setZError error

Full Usage: Trace.setZError error

Parameters:
    error : Error - The new error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Returns a function that sets the Error object for the x dimension of the given trace.

error : Error

The new error object

Returns: 'a -> 'a

Trace.tryGetTypedMember propName trace

Full Usage: Trace.tryGetTypedMember propName trace

Parameters:
    propName : string - The name of the dynamic member to get the value of
    trace : Trace - The trace to get the dynamic member value from

Returns: 'T option
Type parameters: 'T

Returns Some(dynamic member value) of the trace object's underlying DynamicObj when a dynamic member with the given name exists, and None otherwise.

propName : string

The name of the dynamic member to get the value of

trace : Trace

The trace to get the dynamic member value from

Returns: 'T option

Trace.updateColorBar colorBar

Full Usage: Trace.updateColorBar colorBar

Parameters:
    colorBar : ColorBar - The updated ColorBar object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given ColorBar object with the one already present on the trace.

colorBar : ColorBar

The updated ColorBar object

Returns: 'a -> 'a

Trace.updateDomain domain

Full Usage: Trace.updateDomain domain

Parameters:
    domain : Domain - The updated Domain object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given Domain object with the one already present on the trace.

domain : Domain

The updated Domain object

Returns: 'a -> 'a

Trace.updateLine line

Full Usage: Trace.updateLine line

Parameters:
    line : Line - The updated Line object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given Line object with the one already present on the trace.

line : Line

The updated Line object

Returns: 'a -> 'a

Trace.updateMarker marker

Full Usage: Trace.updateMarker marker

Parameters:
    marker : Marker - The updated Trace object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given marker object with the one already present on the trace.

marker : Marker

The updated Trace object

Returns: 'a -> 'a

Trace.updateXError error

Full Usage: Trace.updateXError error

Parameters:
    error : Error - The updated Error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given Error object for the x dimension with the one already present on the trace.

error : Error

The updated Error object

Returns: 'a -> 'a

Trace.updateYError error

Full Usage: Trace.updateYError error

Parameters:
    error : Error - The updated Error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given Error object for the y dimension with the one already present on the trace.

error : Error

The updated Error object

Returns: 'a -> 'a

Trace.updateZError error

Full Usage: Trace.updateZError error

Parameters:
    error : Error - The updated Error object

Returns: 'a -> 'a
Type parameters: 'a (requires :> Plotly.NET.Trace)

Combines the given Error object for the z dimension with the one already present on the trace.

error : Error

The updated Error object

Returns: 'a -> 'a

Type something to start searching.