XPlot


PlotlyChart Type

Namespace: XPlot.Plotly

Assembly: XPlot.Plotly.dll

Base Type: obj

Record fields

Record Field Description

labels

Full Usage: labels

Modifiers: mutable

layout

Full Usage: layout

Modifiers: mutable

traces

Full Usage: traces

Modifiers: mutable

Constructors

Constructor Description

PlotlyChart()

Full Usage: PlotlyChart()

Returns: PlotlyChart

Returns: PlotlyChart

Instance members

Instance member Description

this.GetHtml()

Full Usage: this.GetHtml()

Returns: string

Returns the chart's full HTML source.

Returns: string

this.GetInlineHtml()

Full Usage: this.GetInlineHtml()

Returns: string

Inline markup that can be embedded in a HTML document.

Returns: string

this.GetInlineJS()

Full Usage: this.GetInlineJS()

Returns: string

The chart's inline JavaScript code.

Returns: string

this.GetPlottingJS()

Full Usage: this.GetPlottingJS()

Returns: string

The chart's plotting JavaScript code.

Returns: string

this.Height

Full Usage: this.Height

The height of the chart container element.

this.Id

Full Usage: this.Id

The chart's container div id.

this.Plot(data, ?Layout, ?Labels)

Full Usage: this.Plot(data, ?Layout, ?Labels)

Parameters:
    data : seq<'a>
    ?Layout : Layout
    ?Labels : seq<string>

data : seq<'a>
?Layout : Layout
?Labels : seq<string>

this.PlotlySrc

Full Usage: this.PlotlySrc

The plotly.js src.

this.Show()

Full Usage: this.Show()

this.Width

Full Usage: this.Width

The width of the chart container element.

this.WithHeight(height)

Full Usage: this.WithHeight(height)

Parameters:
    height : int

Sets the chart's height.

height : int

this.WithId(newId)

Full Usage: this.WithId(newId)

Parameters:
    newId : string

Sets the chart's container div id.

newId : string

this.WithLabel(label)

Full Usage: this.WithLabel(label)

Parameters:
    label : string

Sets the data series label. Use this member if the chart's data is a single series.

label : string

this.WithLabels(labels)

Full Usage: this.WithLabels(labels)

Parameters:
    labels : seq<string>

Sets the data series labels. Use this method if the chart's data is a series collection.

labels : seq<string>

this.WithLayout(layoutObj)

Full Usage: this.WithLayout(layoutObj)

Parameters:

Sets the chart's configuration options.

layoutObj : Layout

this.WithLegend(enabled)

Full Usage: this.WithLegend(enabled)

Parameters:
    enabled : bool

Display/hide the legend.

enabled : bool

this.WithOptions(options)

Full Usage: this.WithOptions(options)

Parameters:

Sets the chart's configuration options.

options : Layout

this.WithPlotlySrc(src)

Full Usage: this.WithPlotlySrc(src)

Parameters:
    src : string

Sets the chart's plotly.js src.

src : string

this.WithSize(width, height)

Full Usage: this.WithSize(width, height)

Parameters:
    width : int
    height : int

Sets the chart's width and height.

width : int
height : int

this.WithTitle(title)

Full Usage: this.WithTitle(title)

Parameters:
    title : string

Sets the chart's title.

title : string

this.WithWidth(width)

Full Usage: this.WithWidth(width)

Parameters:
    width : int

Sets the chart's width.

width : int

this.WithXTitle(xTitle)

Full Usage: this.WithXTitle(xTitle)

Parameters:
    xTitle : string

Sets the chart's X-axis title.

xTitle : string

this.WithYTitle(yTitle)

Full Usage: this.WithYTitle(yTitle)

Parameters:
    yTitle : string

Sets the chart's Y-axis title.

yTitle : string