Packages

  • package root
    Definition Classes
    root
  • package scalax
    Definition Classes
    root
  • package chart

    This package contains a library for creating and working with charts.

    This package contains a library for creating and working with charts. It wraps JFreeChart, much like scala.swing does with the original javax.swing package.

    Getting Started

    There is an all you can eat import providing all the high-level functionality of this library:

    import scalax.chart.api._
    
    val data = for (i <- 1 to 5) yield (i,i)
    val chart = XYLineChart(data)
    chart.saveAsPNG("/tmp/chart.png")

    All of the functionality of the api object is also contained by module.Charting, which you can either import or use as a mixin:

    object MyChartApp extends App with scalax.chart.module.Charting {
      val data = for (i <- 1 to 5) yield (i,i)
      val chart = XYLineChart(data)
      chart.saveAsPNG("/tmp/chart.png")
    }

    The module package provides a la carte imports, which you can import or mix in for only parts of the API. To find out more about the modules in detail, have a look at the documentation of the module.Charting module. From there on you can discover the modules one by one.

    Definition Classes
    scalax
  • package event
    Definition Classes
    chart
  • package exporting
    Definition Classes
    chart
  • package module

    This package provides a la carte imports.

    This package provides a la carte imports. It is organized into modules following the Scala's Selfless Trait Pattern. Some of these modules depend on each other. In this case, there is often a short documentation in the higher-level module and links to the lower-level modules. Have a look for yourself and start at the highest-level all you can eat module Charting.

    Definition Classes
    chart
  • Axis
  • CategoryChart
  • Chart
  • ChartCompanion
  • DocMacros
  • MultiplePieChart
  • PieChart
  • RingChart
  • SpiderWebChart
  • XYChart
  • api
t

scalax.chart

DocMacros

trait DocMacros extends Any

Mixin solely for the purpose of providing common documentation macros.

Concrete

The following list contains macros that are usually overridden by concrete representations:

  • $chart = chart
  • $Chart = Chart

Basic

The following list contains basic macros that are usually not overridden:

  • $data = the data the chart will visualize
  • $legend = whether or not the chart will contain a legend
  • $orientation = the orientation of the chart
  • $peer = the underlying chart
  • $resolution = dimension / geometry / width x height
  • $theme = the theme to apply to the chart
  • $title = the title of the chart
Source
DocMacros.scala
Linear Supertypes
Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocMacros
  2. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getClass(): Class[_]
    Definition Classes
    Any

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DocMacros to any2stringadd[DocMacros] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DocMacros, B)
    Implicit
    This member is added by an implicit conversion from DocMacros to ArrowAssoc[DocMacros] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def ensuring(cond: (DocMacros) ⇒ Boolean, msg: ⇒ Any): DocMacros
    Implicit
    This member is added by an implicit conversion from DocMacros to Ensuring[DocMacros] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (DocMacros) ⇒ Boolean): DocMacros
    Implicit
    This member is added by an implicit conversion from DocMacros to Ensuring[DocMacros] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: ⇒ Any): DocMacros
    Implicit
    This member is added by an implicit conversion from DocMacros to Ensuring[DocMacros] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): DocMacros
    Implicit
    This member is added by an implicit conversion from DocMacros to Ensuring[DocMacros] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def equals(arg0: Any): Boolean
    Definition Classes
    Any
  12. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DocMacros to StringFormat[DocMacros] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  13. def hashCode(): Int
    Definition Classes
    Any
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def toString(): String
    Definition Classes
    Any
  16. def [B](y: B): (DocMacros, B)
    Implicit
    This member is added by an implicit conversion from DocMacros to ArrowAssoc[DocMacros] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Any

Inherited by implicit conversion any2stringadd from DocMacros to any2stringadd[DocMacros]

Inherited by implicit conversion StringFormat from DocMacros to StringFormat[DocMacros]

Inherited by implicit conversion Ensuring from DocMacros to Ensuring[DocMacros]

Inherited by implicit conversion ArrowAssoc from DocMacros to ArrowAssoc[DocMacros]

Ungrouped