plotlykt-server/space.kscience.plotly.server

Package-level declarations

Types

MetaChangeCollector

class MetaChangeCollector

A change collector that combines all emitted configuration changes until read, than drops all collected changes and starts new batch.

class PlotlyServer : Configurable, CoroutineScope

PlotlyServerConfiguration

object PlotlyServerConfiguration : Scheme

PlotlyServerIntegration

class PlotlyServerIntegration : JupyterIntegration

PlotlyUpdateMode

enum PlotlyUpdateMode : Enum<PlotlyUpdateMode>

sealed class Update

An update message for both data and layout

Properties

val Plotly.jupyter: PlotlyServerConfiguration

Global plotly jupyter configuration

Functions

fun ApplicationEngine.close()

fun Plot.collectUpdates(plotId: String, scope: CoroutineScope, updateInterval: Int): Flow<Update>

fun PlotlyServer.plot(plotId: String? = null, config: PlotlyConfig = PlotlyConfig(), plotBuilder: Plot.() -> Unit)

A shortcut to make a single plot at the default page

fun Application.plotlyModule(route: String = DEFAULT_PAGE, block: PlotlyServer.() -> Unit = {}): PlotlyServer

Attach plotly application to given server

fun PlotlyServer.pullUpdates(interval: Int = 500): PlotlyServer

Configure client to request regular updates from server. Pull updates are more expensive than push updates since they contain the full plot data and server can't decide what to send.

fun PlotlyServer.pushUpdates(interval: Int = 100): PlotlyServer

Configure server to start sending updates in push mode. Does not affect loaded pages

fun Plotly.serve(scope: CoroutineScope = GlobalScope, host: String = "localhost", port: Int = 7777, block: PlotlyServer.() -> Unit): ApplicationEngine

Start static server (updates via reload)

fun ApplicationEngine.show()