Class/Object

scalatikz.graphics.pgf

Figure

Related Docs: object Figure | package pgf

Permalink

final class Figure extends TIKZPicture[PGFPlot] with PGFPlot

Linear Supertypes
PGFPlot, Graphic, TIKZPicture[PGFPlot], Logging, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Figure
  2. PGFPlot
  3. Graphic
  4. TIKZPicture
  5. Logging
  6. LazyLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def area(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 1, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN, pattern: Pattern = PLAIN, opacity: Double = 0.5, smooth: Boolean = false, constant: Boolean = false)(data: Data): Figure

    Permalink

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate and fills the area beneath the curve.

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate and fills the area beneath the curve.

    color

    line color (default is a random color)

    marker

    mark style (default none)

    markStrokeColor

    mark stroke color (optional)

    markFillColor

    mark fill color (optional)

    markSize

    mark size (default is 1 pt)

    lineStyle

    line style (default is solid)

    lineSize

    line size (default is thin)

    pattern

    the pattern to fill the area (default is plain color)

    opacity

    opacity of the area under curve (default is 0.5)

    smooth

    true for a smooth line (default is false)

    constant

    true for a constant area (default is false)

    data

    sequence of x, y points in the Euclidean space

  5. def area(data: Data): Figure

    Permalink

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate and fills the area beneath the curve.

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate and fills the area beneath the curve.

    data

    sequence of x, y points in the Euclidean space

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val axis: Axis

    Permalink
  8. def bar(color: Color = nextColor, pattern: Pattern = PLAIN, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN, opacity: Double = 1, barWidth: Double = 0.5)(data: Data): Figure

    Permalink

    Plots a data sequence as a bar graph of the data in Y coordinate versus the corresponding X coordinate.

    Plots a data sequence as a bar graph of the data in Y coordinate versus the corresponding X coordinate.

    color

    line color (default random color)

    pattern

    a pattern to fill the bars (default is plain color)

    lineStyle

    line style (default is solid)

    lineSize

    line size (default is thin)

    opacity

    opacity of the bars (default is 1)

    barWidth

    the bars width (default is 0.5 pt)

    data

    sequence of x, y points in the Euclidean space

  9. def bar(data: Data): Figure

    Permalink

    Plots a data sequence as a bar graph of the data in Y coordinate versus the corresponding X coordinate.

    Plots a data sequence as a bar graph of the data in Y coordinate versus the corresponding X coordinate.

    data

    sequence of x, y points in the Euclidean space

    returns

    a figure containing the bar graph

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def errorBar(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 1, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN, smooth: Boolean = false)(data: Data)(error: Data): Figure

    Permalink

    Plots a 2D line of the data in Y versus the corresponding values in X along vertical and/or horizontal error bars at each data point.

    Plots a 2D line of the data in Y versus the corresponding values in X along vertical and/or horizontal error bars at each data point.

    color

    line color

    marker

    mark style

    markStrokeColor

    mark stroke color

    markFillColor

    mark fill color

    markSize

    mark size

    lineStyle

    line style

    lineSize

    line size

    smooth

    true in case the line is smooth

    data

    sequence of x, y points in the Euclidean space along a sequence of x-error, y-error points.

  14. def errorBar(data: Data)(error: Data): Figure

    Permalink

    Plots a 2D line of the data in Y versus the corresponding values in X along vertical and/or horizontal error bars at each data point.

    Plots a 2D line of the data in Y versus the corresponding values in X along vertical and/or horizontal error bars at each data point.

    data

    sequence of x, y points in the Euclidean space along a sequence of x-error, y-error points.

  15. def fatal(message: ⇒ String, cause: Throwable): Nothing

    Permalink
    Definition Classes
    Logging
  16. def fatal(message: ⇒ String): Nothing

    Permalink
    Definition Classes
    Logging
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. val graphics: Seq[PGFPlot]

    Permalink
    Definition Classes
    FigureTIKZPicture
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def havingAxisXLabels(labels: Seq[String]): Figure

    Permalink

    Changes the X axis tick labels.

    Changes the X axis tick labels.

    labels

    a list of labels

    returns

    a Figure having the given X axis tick labels

  22. def havingAxisYLabels(labels: Seq[String]): Figure

    Permalink

    Changes the Y axis tick labels.

    Changes the Y axis tick labels.

    labels

    a list of labels

    returns

    a Figure having the given Y axis tick labels

  23. def havingBackgroundColor(color: Color): Figure

    Permalink

    Sets the axis background color

    Sets the axis background color

    color

    a color

    returns

    a Figure having the given background color

    See also

    scalatikz.graphics.pgf.enums.Color

  24. def havingFontSize(size: FontSize): Figure

    Permalink

    Sets the font size.

    Sets the font size.

    size

    a size

    returns

    a Figure having the given font size

  25. def havingGridsOn: Figure

    Permalink

    returns

    a Figure having both major and minor grids enabled

  26. def havingLegendPos(pos: LegendPos): Figure

    Permalink

    Sets the legends position.

    Sets the legends position.

    pos

    a legend position

    returns

    a Figure having the given legend position

    See also

    scalatikz.graphics.pgf.enums.LegendPos

  27. def havingLegends(legends: String*): Figure

    Permalink

    Sets the legends of the data sequences.

    Sets the legends of the data sequences.

    legends

    a sequence of legends

    returns

    a Figure having the given legends

  28. def havingLimits(xMin: Double, xMax: Double, yMin: Double, yMax: Double): Figure

    Permalink

    Sets the bounds for both X and Y axis.

    Sets the bounds for both X and Y axis.

    xMin

    X lower bound

    xMax

    X upper bound

    yMin

    Y lower bound

    yMax

    Y upper bound

    returns

    a Figure having the given bounds on X and Y axis

  29. def havingLogLogAxis: Figure

    Permalink

    returns

    a Figure having both X and Y log scale axis

  30. def havingLogXAxis: Figure

    Permalink

    returns

    a Figure having X log scale axis

  31. def havingLogYAxis: Figure

    Permalink

    returns

    a Figure having Y log scale axis

  32. def havingMajorGridOn: Figure

    Permalink

    returns

    a Figure having major grid enabled

  33. def havingMinorGridOn: Figure

    Permalink

    returns

    a Figure having minor grid enabled

  34. def havingName(name: String): Figure

    Permalink

    Rename the figure.

    Rename the figure.

    name

    a name for the figure

    returns

    a Figure having the given name

  35. def havingTitle(title: String): Figure

    Permalink

    Sets the figure title.

    Sets the figure title.

    title

    a figure title

    returns

    a Figure having the given title

  36. def havingXAxisLinePos(pos: AxisLinePos): Figure

    Permalink

    Sets the position of the X axis.

    Sets the position of the X axis.

    pos

    an axis position

    returns

    a Figure having the given position on the X axis

    See also

    scalatikz.graphics.pgf.enums.AxisLinePos

  37. def havingXLabel(label: String): Figure

    Permalink

    Sets a label on the X axis.

    Sets a label on the X axis.

    label

    a label for the X axis

    returns

    a Figure having the given label on the X axis

  38. def havingXLimits(min: Double, max: Double): Figure

    Permalink

    Sets the bounds of the X axis.

    Sets the bounds of the X axis.

    min

    X lower bound

    max

    X upper bound

    returns

    a Figure having the given bounds on the X axis

  39. def havingYAxisLinePos(pos: AxisLinePos): Figure

    Permalink

    Sets the position of the Y axis.

    Sets the position of the Y axis.

    pos

    an axis position

    returns

    a Figure having the given position on the Y axis

    See also

    scalatikz.graphics.pgf.enums.AxisLinePos

  40. def havingYLabel(label: String): Figure

    Permalink

    Sets a label on the Y axis.

    Sets a label on the Y axis.

    label

    a label for the Y axis

    returns

    a Figure having the given label on the Y axis

  41. def havingYLimits(min: Double, max: Double): Figure

    Permalink

    Sets the bounds of the Y axis.

    Sets the bounds of the Y axis.

    min

    Y lower bound

    max

    Y upper bound

    returns

    a Figure having the given bounds on the Y axis

  42. def hideXAxisTicks: Figure

    Permalink

    Hides the ticks appearing in the X axis.

    Hides the ticks appearing in the X axis.

    returns

    a Figure having hidden ticks in the X axis

  43. def hideYAxisTicks: Figure

    Permalink

    Hides the ticks appearing in the Y axis.

    Hides the ticks appearing in the Y axis.

    returns

    a Figure having hidden ticks in the Y axis

  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  46. val name: String

    Permalink
    Definition Classes
    FigureTIKZPicture
  47. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. def plot(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 1, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN, smooth: Boolean = false)(data: Data): Figure

    Permalink

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate.

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate.

    color

    line color (default random color)

    marker

    mark style (default none)

    markStrokeColor

    mark stroke color (optional)

    markFillColor

    mark fill color (optional)

    markSize

    mark size (default is 1 pt)

    lineStyle

    line style (default is solid)

    lineSize

    line size (default is thin)

    smooth

    true for a smooth line (default is false)

    data

    sequence of x, y points in the Euclidean space

  51. def plot(data: Data): Figure

    Permalink

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate.

    Plots a data sequence as a 2D line of the data in Y coordinate versus the corresponding X coordinate.

    data

    sequence of x, y points in the Euclidean space

  52. def polar(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 2, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN, smooth: Boolean = false)(data: Data): Figure

    Permalink
  53. def polar(data: Data): Figure

    Permalink
  54. def polarScatter(marker: Mark = NONE, markStrokeColor: Color = nextColor, markFillColor: Color = currentColor, markSize: Double = 2)(data: Data): Figure

    Permalink
  55. def polarScatter(data: Data): Figure

    Permalink
  56. def rotateXTicks(degrees: Int): Figure

    Permalink

    Rotates the X axis ticks by the given degrees.

    Rotates the X axis ticks by the given degrees.

    degrees

    the degrees to rotate the ticks

    returns

    a Figure having the X ticks rotated

  57. def rotateYTicks(degrees: Int): Figure

    Permalink

    Rotates the Y axis ticks by the given degrees.

    Rotates the Y axis ticks by the given degrees.

    degrees

    the degrees to rotate the ticks

    returns

    a Figure having the Y ticks rotated

  58. final def saveAsJPEG(path: String, compiler: Compiler = PDFLATEX): Try[File]

    Permalink

    Save a JPEG generated by the TIKZ picture into the given path.

    Save a JPEG generated by the TIKZ picture into the given path.

    path

    a path to save the generated JPEG

    returns

    a Try holding the saved JPEG file. In case of non-fatal exception, a Failure object is returned holding the exception.

    Definition Classes
    TIKZPicture
  59. final def saveAsPDF(path: String, compiler: Compiler = PDFLATEX): Try[File]

    Permalink

    Save a PDF generated by the TIKZ picture into the given path.

    Save a PDF generated by the TIKZ picture into the given path.

    path

    a path to save the generated PDF

    returns

    a Try holding the saved PDF file. In case of non-fatal exception, a Failure object is returned holding the exception.

    Definition Classes
    TIKZPicture
  60. final def saveAsPNG(path: String, compiler: Compiler = PDFLATEX): Try[File]

    Permalink

    Save a PNG generated by the TIKZ picture into the given path.

    Save a PNG generated by the TIKZ picture into the given path.

    path

    a path to save the generated PNG

    returns

    a Try holding the saved PNG file. In case of non-fatal exception, a Failure object is returned holding the exception.

    Definition Classes
    TIKZPicture
  61. final def saveAsTeX(path: String): Try[File]

    Permalink

    Save a TeX generated by the TIKZ picture into the given path.

    Save a TeX generated by the TIKZ picture into the given path.

    path

    a path to save the generated TeX file

    returns

    a Try holding the saved TeX file. In case of non-fatal exception, a Failure object is returned holding the exception.

    Definition Classes
    TIKZPicture
  62. def scatter(marker: Mark = NONE, markStrokeColor: Color = nextColor, markFillColor: Color = currentColor, markSize: Double = 1)(data: Data): Figure

    Permalink

    Plots a data sequence as a scatter at the locations specified by the data sequence.

    Plots a data sequence as a scatter at the locations specified by the data sequence. The type of the graph is also called a bubble plot.

    marker

    mark style (default none)

    markStrokeColor

    mark stroke color (optional)

    markFillColor

    mark fill color (optional)

    markSize

    mark size (default is 1 pt)

    data

    sequence of x, y points in the Euclidean space

  63. def scatter(data: Data): Figure

    Permalink

    Plots a data sequence as a scatter at the locations specified by the data sequence.

    Plots a data sequence as a scatter at the locations specified by the data sequence. The type of the graph is also called a bubble plot.

    data

    sequence of x, y points in the Euclidean space

  64. final def show(compiler: Compiler = PDFLATEX): Unit

    Permalink

    Generate and open the resulted figure as PDF using the default desktop application used for PDFs.

    Generate and open the resulted figure as PDF using the default desktop application used for PDFs.

    Definition Classes
    TIKZPicture
  65. def stair(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 1, lineStyle: LineStyle = SOLID, lineSize: LineSize = THIN)(data: Data): Figure

    Permalink

    Plots a data sequence as a stair step of the data in Y versus the corresponding values in X.

    Plots a data sequence as a stair step of the data in Y versus the corresponding values in X.

    color

    line color (default random color)

    marker

    mark style (default none)

    markStrokeColor

    mark stroke color (optional)

    markFillColor

    mark fill color (optional)

    markSize

    mark size (default is 1 pt)

    lineStyle

    line style (default is solid)

    lineSize

    line size (default is thin)

    data

    sequence of x, y points in the Euclidean space

  66. def stair(data: Data): Figure

    Permalink

    Plots a data sequence as a stair step of the data in Y versus the corresponding values in X.

    Plots a data sequence as a stair step of the data in Y versus the corresponding values in X.

    data

    sequence of x, y points in the Euclidean space

  67. def stem(color: Color = nextColor, marker: Mark = NONE, markStrokeColor: Color = currentColor, markFillColor: Color = currentColor, markSize: Double = 1)(data: Data): Figure

    Permalink

    Plots a data sequence as stems that extend from a baseline along the x-axis.

    Plots a data sequence as stems that extend from a baseline along the x-axis. The data values are indicated by marks terminating each stem.

    color

    line color (default random color)

    marker

    mark style (default none)

    markStrokeColor

    mark stroke color (optional)

    markFillColor

    mark fill color (optional)

    markSize

    mark size (default is 1 pt)

    data

    sequence of x, y points in the Euclidean space

  68. def stem(data: Data): Figure

    Permalink

    Plots a data sequence as stems that extend from a baseline along the x-axis.

    Plots a data sequence as stems that extend from a baseline along the x-axis. The data values are indicated by marks terminating each stem.

    data

    sequence of x, y points in the Euclidean space

  69. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  70. def toString(): String

    Permalink
    Definition Classes
    Figure → AnyRef → Any
  71. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PGFPlot

Inherited from Graphic

Inherited from TIKZPicture[PGFPlot]

Inherited from Logging

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped