nspl-core
API
Generated with
nspl-core/org.nspl/Parameters

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
Show all

Members list

Value members

Concrete methods

def bottomPadding(v: RelFontSize): Parameters

Value parameters

bottomPadding

padding around the whole plot

Attributes

def draw1Line(v: Boolean): Parameters

Value parameters

draw1Line

draws the y=x line

Attributes

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

Value parameters

extraLegend

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

Attributes

def frame(v: Boolean): Parameters

Value parameters

frame

Draw a rectangular frame around the plot area

Attributes

def leftPadding(v: RelFontSize): Parameters

Value parameters

leftPadding

padding around the whole plot

Attributes

def legendDistance(v: RelFontSize): Parameters

Value parameters

legendDistance

Distance of the legend items from other legend items

Attributes

def legendFontSize(v: RelFontSize): Parameters

Value parameters

legendFontSize

Font size of the legend

Attributes

def legendLayout(v: Layout): Parameters

Value parameters

legendLayout

Layout of the legend items

Attributes

def legendWidth(v: RelFontSize): Parameters

Value parameters

legendWidth

Width of the legend

Attributes

def main(v: String): Parameters

Value parameters

main

main plot label (title)

Attributes

def mainFontSize(v: RelFontSize): Parameters

Value parameters

mainFontSize

font size of main

Attributes

def mainLabDistance(v: RelFontSize): Parameters

Value parameters

mainLabDistance

main to frame distance

Attributes

def noLegend(v: Boolean): Parameters

Value parameters

noLegend

skip drawing legend

Attributes

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

Value parameters

origin

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

Attributes

def rightPadding(v: RelFontSize): Parameters

Value parameters

rightPadding

padding around the whole plot

Attributes

def topPadding(v: RelFontSize): Parameters

Value parameters

topPadding

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

Attributes

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 withXLabelRotation(v: Double): 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 withXNumTicks(v: Int): 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 withYLabelRotation(v: Double): 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 withYNumTicks(v: Int): Parameters
def withYTickSpace(v: Option[Double]): Parameters
def xAxisMargin(v: Double): Parameters

Value parameters

xAxisMargin

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

Attributes

def xCustomGrid(v: Boolean): Parameters

Value parameters

xCustomGrid

custom grid lines on x axis

Attributes

def xLabDistance(v: RelFontSize): Parameters

Value parameters

xLabDistance

xlab to axis distance

Attributes

def xLabFontSize(v: RelFontSize): Parameters

Value parameters

xLabFontSize

font size of xlab

Attributes

def xLabelRotation(v: Double): Parameters

Value parameters

xLabelRotation

x axis label rotation

Attributes

def xLineStartFraction(v: Double): Parameters

Value parameters

xLineStartFraction

The start of the line which represents the x axis

Attributes

def xLineWidthFraction(v: Double): Parameters

Value parameters

xLineWidthFraction

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

Attributes

def xNoTickLabel(v: Boolean): Parameters

Value parameters

xNoTickLabel

skip drawing tick labels on x axis

Attributes

def xNumTicks(v: Int): Parameters

Value parameters

xNumTicks

number of ticks on the x axis

Attributes

def xTickFontSize(v: RelFontSize): Parameters

Value parameters

xLabFontSize

font size of x ticks

Attributes

def xTickLength(v: RelFontSize): Parameters

Value parameters

xTickLength

tick length on x axis

Attributes

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

Value parameters

xTickSpace

x axis tick spacing, automatic if empty, recommended empty

Attributes

def xWidth(v: RelFontSize): Parameters

Value parameters

xWidth

Width of the x axis in relative font size units

Attributes

def xgrid(v: Boolean): Parameters

Value parameters

xgrid

Draw background grid at major ticks on x axis

Attributes

def xlab(v: String): Parameters

Value parameters

xlab

x axis label

Attributes

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

Value parameters

xlim

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

Attributes

def xlog(v: Boolean): Parameters

Value parameters

xlog

x axis is in log space

Attributes

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

Value parameters

xnames

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

Attributes

def yAxisMargin(v: Double): Parameters

Value parameters

yAxisMargin

Defines the limit of the y axis.

Attributes

def yCustomGrid(v: Boolean): Parameters

Value parameters

yCustomGrid

custom grid line son y axis

Attributes

def yHeight(v: RelFontSize): Parameters

Value parameters

yHeight

height of the y axis in relative font size units

Attributes

def yLabDistance(v: RelFontSize): Parameters

Value parameters

yLabDistance

ylab to axis distance

Attributes

def yLabFontSize(v: RelFontSize): Parameters

Value parameters

yLabFontSize

font size of ylab

Attributes

def yLabelRotation(v: Double): Parameters

Value parameters

yLabelRotation

y axis label rotation

Attributes

def yLineStartFraction(v: Double): Parameters

Value parameters

yLineStartFraction

The start of the line which represents the x axis

Attributes

def yLineWidthFraction(v: Double): Parameters

Value parameters

yLineWidthFraction

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

Attributes

def yNoTickLabel(v: Boolean): Parameters

Value parameters

yNoTickLabel

skip drawing tick labels on y axi

Attributes

def yNumTicks(v: Int): Parameters

Value parameters

yNumTicks

number of ticks on the y axis

Attributes

def yTickFontSize(v: RelFontSize): Parameters

Value parameters

yLabFontSize

font size of y ticks

Attributes

def yTickLength(v: RelFontSize): Parameters

Value parameters

yTickLength

tick length on y axis

Attributes

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

Value parameters

yTickSpace

y axis tick spacing, automatic if empty, recommended empty

Attributes

def ygrid(v: Boolean): Parameters

Value parameters

ygrid

Draw background grid at major ticks on y axis

Attributes

def ylab(v: String): Parameters

Value parameters

ylab

y axis label

Attributes

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

Value parameters

ylim

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

Attributes

def ylog(v: Boolean): Parameters

Value parameters

ylog

y axis is in log space

Attributes

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

Value parameters

ynames

custo ticks on the y axis

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with