Package space.kscience.plotly

Types

DownloadImgOpts

external interface DownloadImgOpts

OrcaFormat

jvm

enum OrcaFormat : Enum<OrcaFormat>

Output format for Orca export

Plot

common

class Plot(config: Config) : Configurable, MetaRepr

The main plot class.

PlotGrid

jvm

class PlotGrid

Plotly

common

object Plotly

A namespace for utility functions

PlotlyConfig

common

class PlotlyConfig : Scheme

PlotlyFragment

jvm

class PlotlyFragment(render: FlowContent.(renderer: PlotlyRenderer) -> Unit)

A custom HTML fragment including plotly container reference

PlotlyHtmlFragment

jvm

class PlotlyHtmlFragment(visit: TagConsumer<*>.() -> Unit)

PlotlyJs

external object PlotlyJs

PlotlyPage

jvm

data class PlotlyPage(headers: Collection<PlotlyHtmlFragment>, fragment: PlotlyFragment, title: String, renderer: PlotlyRenderer)

A complete page including headers and title

PlotlyRenderer

jvm

interface PlotlyRenderer

PlotTabs

jvm

class PlotTabs

ResourceLocation

jvm

enum ResourceLocation : Enum<ResourceLocation>

The location of resources for plot.

StaticPlotlyRenderer

jvm

object StaticPlotlyRenderer : PlotlyRenderer

ToImgOpts

external interface ToImgOpts

UnstablePlotlyAPI

common

annotation class UnstablePlotlyAPI

UnsupportedPlotlyAPI

common

annotation class UnsupportedPlotlyAPI

Functions

bar

common

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

box

common

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

contour

common

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

createPlotFrom

fun createPlotFrom(id: String, from: URL, config: dynamic = {})

Create a plot taking data from given url

display

jvm

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

export

jvm

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

Use external plotly-orca (https://github.com/plotly/orca) tool to export static image.

fragment

jvm

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

grid

jvm

fun Plotly.grid(block: PlotGrid.() -> Unit): PlotlyPage

heatmap

common

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

histogram

common

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

histogram2d

common

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

histogram2dcontour

common

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

layout

common

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

Configure the layout

localCssHeader

jvm

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

localScriptHeader

jvm

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

A header that automatically copies relevant scripts to given path

makeFile

jvm

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.

page

jvm

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

common

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

plot

inline fun <ERROR CLASS><HTMLElement>.plot(plotlyConfig: PlotlyConfig = PlotlyConfig(), plotBuilder: Plot.() -> Unit)

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

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())

Attach a plot to this element or update existing plot

plus

jvm

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

scatter

common

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

selectFile

jvm

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

Select a file to save plot to using Swing form.

shape

common

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

startPull

fun startPull(id: String, from: URL, millis: Int)

Start pull updates with regular requests from client side

startPush

fun startPush(id: String, ws: String)

Start push updates via websocket

table

common

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

tabs

jvm

fun Plotly.tabs(tabsID: String = "tabs", block: PlotTabs.() -> Unit): PlotlyPage

text

common

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

toHTML

jvm

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

Create a html (including headers) string from plot

toJsonString

common

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

jvm

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

common

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

Add a generic trace

updatePlotFrom