Parameters

org.nspl.Parameters
See theParameters companion object
case class Parameters

Class which holds common settings of plots.

This class is immmutable.

The intended use of this class is to call the specialized copy methods on the default instance in org.nspl.par e.g.

org.nspl.par.withXLog(true).withMain("some text")

or equivalently

org.nspl.par.xlog(true).main("some text")

For each member of this class there are two copy methods:

  • One following the naming convention withX.. e.g. def withXLog(v:Boolean) : Parameters
  • the other omitting the with prefix, e.g. def xlog(v:Boolean) : Parameters

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

bottomPadding

padding around the whole plot

def draw1Line(v: Boolean): Parameters

Attributes

draw1Line

draws the y=x line

def extraLegend(v: Seq[(String, LegendElem)]): Parameters

Attributes

extraLegend

Items to be added in the plot legend in addition of those derived from the data sources

def frame(v: Boolean): Parameters

Attributes

frame

Draw a rectangular frame around the plot area

Attributes

leftPadding

padding around the whole plot

Attributes

legendDistance

Distance of the legend items from other legend items

Attributes

legendFontSize

Font size of the legend

Attributes

legendLayout

Layout of the legend items

Attributes

legendWidth

Width of the legend

def main(v: String): Parameters

Attributes

main

main plot label (title)

Attributes

mainFontSize

font size of main

Attributes

mainLabDistance

main to frame distance

def noLegend(v: Boolean): Parameters

Attributes

noLegend

skip drawing legend

def origin(v: Option[(Double, Double)]): Parameters

Attributes

origin

World/Axis coordinate of where the two axes will intersect. Data driven if empty.

Attributes

rightPadding

padding around the whole plot

Attributes

topPadding

padding around the whole plot (includes xlab, ylab, main labels)

def withDraw1Line(v: Boolean): Parameters
def withExtraLegend(v: Seq[(String, LegendElem)]): Parameters
def withFrame(v: Boolean): Parameters
def withMain(v: String): Parameters
def withNoLegend(v: Boolean): Parameters
def withOrigin(v: Option[(Double, Double)]): Parameters
def withXAxisMargin(v: Double): Parameters
def withXCustomGrid(v: Boolean): Parameters
def withXGrid(v: Boolean): Parameters
def withXLab(v: String): Parameters
def withXLim(v: Option[(Double, Double)]): Parameters
def withXLog(v: Boolean): Parameters
def withXNames(v: Seq[(Double, String)]): Parameters
def withXNoTickLabel(v: Boolean): Parameters
def withXTickSpace(v: Option[Double]): Parameters
def withYAxisMargin(v: Double): Parameters
def withYCustomGrid(v: Boolean): Parameters
def withYGrid(v: Boolean): Parameters
def withYLab(v: String): Parameters
def withYLim(v: Option[(Double, Double)]): Parameters
def withYLog(v: Boolean): Parameters
def withYNames(v: Seq[(Double, String)]): Parameters
def withYNoTickLabel(v: Boolean): Parameters
def withYTickSpace(v: Option[Double]): Parameters
def xAxisMargin(v: Double): Parameters

Attributes

xAxisMargin

Defines the limit of the x axis. If xlim is empty then the x axis range is (xmax-xmin) * (1+xAxisMargin)

def xCustomGrid(v: Boolean): Parameters

Attributes

xCustomGrid

custom grid lines on x axis

Attributes

xLabDistance

xlab to axis distance

Attributes

xLabFontSize

font size of xlab

def xLabelRotation(v: Double): Parameters

Attributes

xLabelRotation

x axis label rotation

Attributes

xLineStartFraction

The start of the line which represents the x axis

Attributes

xLineWidthFraction

The length of the line visually representing the x axis as a fraction of the logical range of the axis

def xNoTickLabel(v: Boolean): Parameters

Attributes

xNoTickLabel

skip drawing tick labels on x axis

def xNumTicks(v: Int): Parameters

Attributes

xNumTicks

number of ticks on the x axis

Attributes

xTickLength

tick length on x axis

def xTickSpace(v: Option[Double]): Parameters

Attributes

xTickSpace

x axis tick spacing, automatic if empty, recommended empty

Attributes

xWidth

Width of the x axis in relative font size units

def xgrid(v: Boolean): Parameters

Attributes

xgrid

Draw background grid at major ticks on x axis

def xlab(v: String): Parameters

Attributes

xlab

x axis label

def xlim(v: Option[(Double, Double)]): Parameters

Attributes

xlim

limits (range) of the x axis, data driven if empty

def xlog(v: Boolean): Parameters

Attributes

xlog

x axis is in log space

def xnames(v: Seq[(Double, String)]): Parameters

Attributes

xnames

custom ticks on the x axis with location (in world/axis space) and label

def yAxisMargin(v: Double): Parameters

Attributes

yAxisMargin

Defines the limit of the y axis.

def yCustomGrid(v: Boolean): Parameters

Attributes

yCustomGrid

custom grid line son y axis

Attributes

yHeight

height of the y axis in relative font size units

Attributes

yLabDistance

ylab to axis distance

Attributes

yLabFontSize

font size of ylab

def yLabelRotation(v: Double): Parameters

Attributes

yLabelRotation

y axis label rotation

Attributes

yLineStartFraction

The start of the line which represents the x axis

Attributes

yLineWidthFraction

The length of the line visually representing the y axis as a fraction of the logical range of the axis

def yNoTickLabel(v: Boolean): Parameters

Attributes

yNoTickLabel

skip drawing tick labels on y axi

def yNumTicks(v: Int): Parameters

Attributes

yNumTicks

number of ticks on the y axis

Attributes

yTickLength

tick length on y axis

def yTickSpace(v: Option[Double]): Parameters

Attributes

yTickSpace

y axis tick spacing, automatic if empty, recommended empty

def ygrid(v: Boolean): Parameters

Attributes

ygrid

Draw background grid at major ticks on y axis

def ylab(v: String): Parameters

Attributes

ylab

y axis label

def ylim(v: Option[(Double, Double)]): Parameters

Attributes

ylim

limits (range) of the y axis, data driven if empty

def ylog(v: Boolean): Parameters

Attributes

ylog

y axis is in log space

def ynames(v: Seq[(Double, String)]): Parameters

Attributes

ynames

custo ticks on the y axis

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product