data class PlotlyPage(val headers: Collection<PlotlyHtmlFragment>, val fragment: PlotlyFragment, val title: String = "Plotly.kt", val renderer: PlotlyRenderer = StaticPlotlyRenderer)

A complete page including headers and title

PlotlyRenderer

interface PlotlyRenderer

PlotMouseEvent

external interface PlotMouseEvent

ResourceLocation

enum ResourceLocation : Enum<ResourceLocation>

The location of resources for plot.

StaticPlotlyRenderer

object StaticPlotlyRenderer : PlotlyRenderer

ToImgOpts

external interface ToImgOpts

UnstablePlotlyAPI

annotation class UnstablePlotlyAPI

UnsupportedPlotlyAPI

annotation class UnsupportedPlotlyAPI

Properties

cdnBootstrap

val cdnBootstrap: PlotlyHtmlFragment

cdnPlotlyHeader

val cdnPlotlyHeader: PlotlyHtmlFragment

mathJaxHeader

val mathJaxHeader: PlotlyHtmlFragment

Functions

bar

inline fun Plot.bar(block: Bar.() -> Unit): Bar

box

inline fun Plot.box(block: Box.() -> Unit): Box

candlestick

inline fun Plot.candlestick(block: CandleStick.() -> Unit): CandleStick

contour

inline fun Plot.contour(block: Contour.() -> Unit): Contour

display

fun Plotly.display(pageBuilder: FlowContent.(renderer: PlotlyRenderer) -> Unit)

export

fun Plot.export(path: Path, format: OrcaFormat = OrcaFormat.svg)

Use external plotly-orca (https://github.com/plotly/orca) tool to export static image. The tool must be installed externally (for example via conda) and usage patterns could differ for different systems.

fragment

fun Plotly.fragment(content: FlowContent.(renderer: PlotlyRenderer) -> Unit): PlotlyFragment

heatmap

inline fun Plot.heatmap(block: Heatmap.() -> Unit): Heatmap

histogram

inline fun Plot.histogram(block: Histogram.() -> Unit): Histogram

histogram2d

inline fun Plot.histogram2d(block: Histogram2D.() -> Unit): Histogram2D

histogram2dcontour

inline fun Plot.histogram2dcontour(block: Histogram2DContour.() -> Unit): Histogram2DContour

layout

inline fun Plot.layout(block: Layout.() -> Unit)

Configure the layout

localCssHeader

fun localCssHeader(basePath: Path, cssPath: Path, resource: String): PlotlyHtmlFragment

localScriptHeader

fun localScriptHeader(basePath: Path, scriptPath: Path, resource: String): PlotlyHtmlFragment

A header that automatically copies relevant scripts to given path

main

fun main()

makeFile

fun PlotlyPage.makeFile(path: Path? = null, show: Boolean = true)

Export a page html to a file.

fun Plot.makeFile(path: Path? = null, show: Boolean = true, resourceLocation: ResourceLocation = ResourceLocation.LOCAL, config: PlotlyConfig = PlotlyConfig())

Create a standalone html with the plot

fun PlotlyFragment.makeFile(path: Path? = null, show: Boolean = true, title: String = "Plotly.kt", resourceLocation: ResourceLocation = ResourceLocation.LOCAL, additionalHeaders: List<PlotlyHtmlFragment> = emptyList())

The same as Plot.makeFile.

fun PlotlyPage.makeFile(path: <Error class: unknown class>)

Export a page html to a file.

fun PlotlyPage.makeFile(path: String)

fun Plot.makeFile(path: String, config: PlotlyConfig = PlotlyConfig())

fun Plot.makeFile(path: <Error class: unknown class>, config: PlotlyConfig = PlotlyConfig())

Create a standalone html with the plot

numberGreaterThan

fun Scheme.numberGreaterThan(minValue: Number, default: Number = minValue, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number ray

numberInRange

fun Scheme.numberInRange(range: ClosedRange<Double>, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number range

fun PlotlyElement.on(eventType: PlotlyEventListenerType, block: MouseEvent.(PlotlyEvent) -> Unit)

page

fun Plotly.page(vararg headers: PlotlyHtmlFragment = arrayOf(cdnPlotlyHeader), title: String = "Plotly.kt", renderer: PlotlyRenderer = StaticPlotlyRenderer, content: FlowContent.(renderer: PlotlyRenderer) -> Unit): PlotlyPage

Create a complete page including plots

pie

inline fun Plot.pie(block: Pie.() -> Unit): Pie

Plot

fun Plot(meta: Meta): Plot

plot

fun FlowContent.plot(plotId: String? = null, config: PlotlyConfig = PlotlyConfig(), renderer: PlotlyRenderer = StaticPlotlyRenderer, builder: Plot.() -> Unit): Plot

fun FlowContent.plot(plot: Plot, plotId: String = plot.toString(), config: PlotlyConfig = PlotlyConfig(), renderer: PlotlyRenderer = StaticPlotlyRenderer): Plot

fun Element.~~plot~~(plot: Plot, plotlyConfig: PlotlyConfig = PlotlyConfig())

inline fun Element.plot(plotlyConfig: PlotlyConfig = PlotlyConfig(), plotBuilder: Plot.() -> Unit)

Create a plot in this element

fun Element.plot(plotlyConfig: PlotlyConfig = PlotlyConfig(), plot: Plot)

Attach a plot to this element or update the existing plot

plotDiv

inline fun TagConsumer<HTMLElement>.plotDiv(plotlyConfig: PlotlyConfig = PlotlyConfig(), plotBuilder: Plot.() -> Unit): PlotlyElement

Render plot in the HTML element using direct plotly API.

fun TagConsumer<HTMLElement>.plotDiv(plotlyConfig: PlotlyConfig = PlotlyConfig(), plot: Plot): PlotlyElement

Create a div element and render plot in it

plus

operator fun PlotlyHtmlFragment.plus(other: PlotlyHtmlFragment): PlotlyHtmlFragment

scatter

inline fun Plot.scatter(block: Scatter.() -> Unit): Scatter

selectFile

fun selectFile(filter: FileNameExtensionFilter? = null): Path?

Select a file to save plot to using Swing form.

shape

fun Plot.shape(block: Shape.() -> Unit)

table

inline fun Plot.table(block: Table.() -> Unit): Table

text

fun Plot.text(block: Text.() -> Unit)

toHTML

fun Plot.toHTML(vararg headers: PlotlyHtmlFragment = arrayOf(cdnPlotlyHeader), config: PlotlyConfig = PlotlyConfig()): String

Create a html (including headers) string from plot

toJsonString

fun List<Scheme>.toJsonString(): String

Convert list of type-safe configurators to json array string

fun Scheme.toJsonString(): String

Convert any type-safe configurator to json string

fun Plot.toJsonString(): String

Convert a plot to Json representation specified by Plotly newPlot command.

toPage

fun PlotlyFragment.toPage(vararg headers: PlotlyHtmlFragment = arrayOf(cdnPlotlyHeader), title: String = "Plotly.kt", renderer: PlotlyRenderer = StaticPlotlyRenderer): PlotlyPage

Convert an html plot fragment to page

fun Plot.toPage(vararg headers: PlotlyHtmlFragment = arrayOf(cdnPlotlyHeader), config: PlotlyConfig = PlotlyConfig.empty(), title: String = "Plotly.kt", renderer: PlotlyRenderer = StaticPlotlyRenderer): PlotlyPage

Convert a plot to the sigle-plot page

trace

inline fun Plot.trace(block: Trace.() -> Unit): Trace

Add a generic trace

violin

inline fun Plot.violin(block: Violin.() -> Unit): Violin