KSLCore/ksl.utilities.io.plotting/ObservationsPlot

ObservationsPlot

class ObservationsPlot(data: DoubleArray, var interval: Interval? = null, dataName: String? = null) : BasePlot

This class displays the data array in the order list. The interval parameter can be used to display a lower limit and upper limit line on the plot.

Parameters

data

the data to plot

interval

the interval to show on the plot

Constructors

ObservationsPlot

constructor(data: IntArray, interval: Interval? = null, dataName: String? = null)

constructor(data: DoubleArray, interval: Interval? = null, dataName: String? = null)

Properties

open override var defaultDPI: Int

the dots per inch for the plot

open override var defaultPlotDir: Path

open override var defaultScale: Int

the scale associated with the plot

open override var height: Int

The height of the container holding the plot

var interval: Interval?

val statistics: Statistic

open override var title: String

The title of the plot

open override var width: Int

The width of the container holding the plot

open override var xLabel: String

the label for the x-axis

open override var yLabel: String

the label for the y-axis

Functions

open override fun buildPlot(): Plot

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

confidenceInterval

fun confidenceInterval(level: Double = 0.99)

open override fun saveToFile(fileName: String, directory: Path, plotTitle: String, extType: PlotIfc.ExtType): File

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.

open override fun toHTML(): String

An HTML representation of the plot for rendering

open override fun toString(): String