Trace Type

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

A Trace object in the context of plotly charts contains the data to visualize and additional styling parameters. This is the base object that contains visualization-unspecific getters and setters for the underlying DynamicObj. Visualization-specific equivalents are suffixed with the respective trace subtype, e.g. `Trace2D`

Constructors

Constructor Description

Trace(traceTypeName)

Full Usage: Trace(traceTypeName)

Parameters:
    traceTypeName : string

Returns: Trace

traceTypeName : string
Returns: Trace

Instance members

Instance member Description

this.type

Full Usage: this.type

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

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

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

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.getLine trace

Full Usage: Trace.getLine trace

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

Returns: Line

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

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

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

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

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

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: 'a8 -> 'a8

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

colorAxisId : int

The new color axis anchor

Returns: 'a8 -> 'a8

Trace.setColorBar colorBar

Full Usage: Trace.setColorBar colorBar

Parameters:
    colorBar : ColorBar - The new ColorBar

Returns: 'T -> 'T

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

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

domain : Domain

The new domain

Returns: 'T -> 'T

Trace.setLine line

Full Usage: Trace.setLine line

Parameters:
    line : Line - The new line object

Returns: 'a8 -> 'a8

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

line : Line

The new line object

Returns: 'a8 -> 'a8

Trace.setMarker marker

Full Usage: Trace.setMarker marker

Parameters:
    marker : Marker - The new marker object

Returns: 'T -> 'T

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

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: 'a8 -> 'a8

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

error : Error

The new error object

Returns: 'a8 -> 'a8

Trace.setYError error

Full Usage: Trace.setYError error

Parameters:
    error : Error - The new error object

Returns: 'a8 -> 'a8

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

error : Error

The new error object

Returns: 'a8 -> 'a8

Trace.setZError error

Full Usage: Trace.setZError error

Parameters:
    error : Error - The new error object

Returns: 'a8 -> 'a8

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

error : Error

The new error object

Returns: 'a8 -> 'a8

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

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: 'a8 -> 'a8

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

colorBar : ColorBar

The updated ColorBar object

Returns: 'a8 -> 'a8

Trace.updateDomain domain

Full Usage: Trace.updateDomain domain

Parameters:
    domain : Domain - The updated Domain object

Returns: 'a -> 'a

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: 'a8 -> 'a8

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

line : Line

The updated Line object

Returns: 'a8 -> 'a8

Trace.updateMarker marker

Full Usage: Trace.updateMarker marker

Parameters:
    marker : Marker - The updated Trace object

Returns: 'a8 -> 'a8

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

marker : Marker

The updated Trace object

Returns: 'a8 -> 'a8

Trace.updateXError error

Full Usage: Trace.updateXError error

Parameters:
    error : Error - The updated Error object

Returns: 'a8 -> 'a8

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

error : Error

The updated Error object

Returns: 'a8 -> 'a8

Trace.updateYError error

Full Usage: Trace.updateYError error

Parameters:
    error : Error - The updated Error object

Returns: 'a8 -> 'a8

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

error : Error

The updated Error object

Returns: 'a8 -> 'a8

Trace.updateZError error

Full Usage: Trace.updateZError error

Parameters:
    error : Error - The updated Error object

Returns: 'a8 -> 'a8

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

error : Error

The updated Error object

Returns: 'a8 -> 'a8