Lightning scala client
Scala client for the Lightning data visualization server (WIP)
##installation
Build the project using sbt and the assembly plugin
sbt assembly
To then use lightning in the scala REPL, just add the jar to your classpath (here we are assuming you launch from inside lightning-scala)
scala -classpath target/scala-2.10/lightning-scala-assembly-0.1.0.jar
##usage
###creating a new session
import org.viz.lightning._
val lgn = Lightning(host="http://my-lightning-instance.herokuapp.com")
lgn.createSession()
lgn.createSession("provide an optional session name")
###creating a visualization Methods are available for the default visualization types included with Lightning
lgn.line(Array(Array(1.0,1.0,2.0,3.0,9.0,20.0)))
lgn.scatter(Array(1.0,2.0,3.0), Array(1.0,1.5,5.0))
###setting options Visualizations can be customized through optional parameters
lgn.line(Array(Array(1.0,1.0,2.0),Array(3.0,9.0,20.0)), label=Array(1,2))
lgn.scatter(Array(1.0,2.0,3.0), Array(1.0,1.5,5.0), label=Array(1,2,3))
###using a custom plot
For any other plot type, just specify by name, and provide the data as a Map
lgn.plot("line", Map("series" -> List(1,1,2,3,9,20)))
This is especially useful when working with custom plot types
##todo The following components need to be added
- Add unit tests
- Add updating and appending
- Add ability to post images
- Add basic type checking on options
- Add implicit conversions on inputs to better handle e.g. Ints and Doubles, and nested arrays
- Finish methods for remaining basic plot types (graph, matrix, adjacency, linestacked, map)
- Add methods for image visualizations (image, gallery)
- Add methods for 3D visualizations (scatter3, volume)
- Add methods for streaming visualizations (scatter, line)
- Add methods for links plots (scatterline)