KSLCore/ksl.utilities.io.plotting/StateVariablePlot

StateVariablePlot

class StateVariablePlot(values: DoubleArray, times: DoubleArray, val responseName: String) : BasePlot

Constructors

constructor(responseTrace: ResponseTrace, repNum: Int, time: Double = Double.MAX_VALUE)

Constructs a plot that has the times and values for the provided replication repNum up to and including the time. The default value of time is Double.MAX_VALUE, which will result in all values for the replication.

constructor(dataMap: Map<String, DoubleArray>, responseName: String)

The data map is assumed to have keys "times" and "values" Element "times" holds the times that the variable changed Element "values" holds the values associated with each time change.

constructor(values: DoubleArray, times: DoubleArray, responseName: String)

Properties

defaultDPI

open override var defaultDPI: Int

the dots per inch for the plot

defaultPlotDir

open override var defaultPlotDir: Path

defaultScale

open override var defaultScale: Int

the scale associated with the plot

height

open override var height: Int

The height of the container holding the plot

responseName

val responseName: String

timeWeightedStatistic

val timeWeightedStatistic: TimeWeightedStatistic

title

open override var title: String

The title of the plot

width

open override var width: Int

The width of the container holding the plot

xLabel

open override var xLabel: String

the label for the x-axis

yLabel

open override var yLabel: String

the label for the y-axis

Functions

buildPlot

open override fun buildPlot(): Plot

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

saveToFile

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

showInBrowser

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.

toHTML

open override fun toHTML(): String

An HTML representation of the plot for rendering

toString

open override fun toString(): String