KSLCore/ksl.utilities.io.plotting/PlotIfc

PlotIfc

interface PlotIfc(source)

Inheritors

Types

object Companion

enum ExtType : Enum<PlotIfc.ExtType>

Properties

abstract var defaultDPI: Int

the dots per inch for the plot

abstract var defaultPlotDir: Path

abstract var defaultScale: Int

the scale associated with the plot

abstract var height: Int

The height of the container holding the plot

abstract var title: String

The title of the plot

abstract var width: Int

The width of the container holding the plot

abstract var xLabel: String

the label for the x-axis

abstract var yLabel: String

the label for the y-axis

Functions

abstract fun buildPlot(): Plot

Builds a new instance of a Lets-Plot representation of the plot

abstract fun saveToFile(fileName: String, directory: Path = defaultPlotDir, plotTitle: String = title, extType: PlotIfc.ExtType = ExtType.PNG): File

abstract fun showInBrowser(plotTitle: String = title): File

Opens up a browser window and shows the contents of the plot within the browser. A temporary file is created to represent the plot for display within the browser.

abstract fun toEmbeddedHTML(): String

Returns an embeddable HTML fragment (a <div> and inline <script>) suitable for compositing into a larger HTML page. Unlike toHTML, this does not include <html>, <head>, or <body> wrappers.

abstract fun toHTML(): String

An HTML representation of the plot for rendering as a standalone page (uses iFrame).

toSelfContainedHTML

abstract fun toSelfContainedHTML(): String

Returns a complete HTML document for the plot that carries its own copy of the Lets-Plot JS library, so it renders wherever it is put without the surrounding page doing anything.