KSLCore/ksl.utilities.io.plotting/BasePlot

BasePlot

abstract class BasePlot : PlotIfc(source)

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open override var defaultDPI: Int

the dots per inch for the plot

Link copied to clipboard
open override var defaultPlotDir: Path
Link copied to clipboard
open override var defaultScale: Int

the scale associated with the plot

Link copied to clipboard
open override var height: Int

The height of the container holding the plot

Link copied to clipboard
open override var title: String

The title of the plot

Link copied to clipboard
open override var width: Int

The width of the container holding the plot

Link copied to clipboard
open override var xLabel: String

the label for the x-axis

Link copied to clipboard
open override var yLabel: String

the label for the y-axis

Functions

Link copied to clipboard
open override fun saveToFile(fileName: String, directory: Path, plotTitle: String, extType: PlotIfc.ExtType): File
Link copied to clipboard
open override fun showInBrowser(plotTitle: String): 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.

Link copied to clipboard
open override fun toEmbeddedHTML(): String

Returns an embeddable HTML fragment (<div> + inline <script>) for compositing into a larger HTML page. The Lets-Plot JS library must be loaded once in the enclosing page's <head> for the fragment to render correctly.

Link copied to clipboard
open override fun toHTML(): String

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

Link copied to clipboard
open override fun toString(): String
Generated by Dokka
© 2026 Copyright