plotlykt-server/space.kscience.plotly.server/PlotlyServer

PlotlyServer

class PlotlyServer : Configurable, CoroutineScope

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val application: Application

Exposes the Ktor application environment to internal logic

Link copied to clipboard
open override val coroutineContext: CoroutineContext
Link copied to clipboard
var dataSourceHost: String?

An override for data (pull/push) service host. By default uses request host

Link copied to clipboard
var dataSourcePort: Int?

An override for data (pull/push) service port. By default uses request port

Link copied to clipboard
Link copied to clipboard
open override val meta: ObservableMutableMeta
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun header(block: TagConsumer<*>.() -> Unit)
Link copied to clipboard
fun page(route: String = DEFAULT_PAGE, title: String = "Plotly server page '", headers: List<PlotlyHtmlFragment> = emptyList(), content: FlowContent.(renderer: PlotlyRenderer) -> Unit)
fun page(plotlyFragment: PlotlyFragment, route: String = DEFAULT_PAGE, title: String = "Plotly server page '", headers: List<PlotlyHtmlFragment> = emptyList())
Link copied to clipboard
fun PlotlyServer.plot(plotId: String? = null, config: PlotlyConfig = PlotlyConfig(), plotBuilder: Plot.() -> Unit)

A shortcut to make a single plot at the default page

Link copied to clipboard
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.

Link copied to clipboard
fun PlotlyServer.pushUpdates(interval: Int = 100): PlotlyServer

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