https://github.com/andreaferretti/paths-scala-js
Scala.js binding for Paths.js
https://github.com/andreaferretti/paths-scala-js
Last synced: 6 months ago
JSON representation
Scala.js binding for Paths.js
- Host: GitHub
- URL: https://github.com/andreaferretti/paths-scala-js
- Owner: andreaferretti
- Created: 2015-02-18T17:59:23.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-05T12:54:19.000Z (almost 7 years ago)
- Last Synced: 2025-04-13T15:05:51.754Z (6 months ago)
- Language: Scala
- Homepage: http://andreaferretti.github.io/paths-scala-js-demo/
- Size: 681 KB
- Stars: 29
- Watchers: 7
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Paths.scala.js
==============
[Paths.js](https://github.com/andreaferretti/paths-js) is a library to generate [SVG paths](http://www.w3.org/TR/SVG/paths.html), allowing you to create your own charts using a functional and testable API. Paths.scala.js is the binding of Paths.js for [Scala.js](http://www.scala-js.org/).
Documentation
-------------
The usage of Paths.scala.js is mostly similar to its parent library. You can
- browse the [documentation of Paths.js](https://github.com/andreaferretti/paths-js/wiki)
- explore the [Scaladocs API](http://andreaferretti.github.io/paths-scala-js)
- see an [example application](https://github.com/andreaferretti/paths-scala-js-demo) ([live demo](http://andreaferretti.github.io/paths-scala-js-demo/))
The demo application is still incomplete, and fails to show many of Paths.scala.js features. The [Paths.js demo](http://andreaferretti.github.io/paths-js-demo/) better showcases what can be done.
Usage
-----
Paths.scala.js is published for Scala 2.11 and Scala 2.12 with Scala.js 0.6. In a Scala.js project, you can depend on Paths.scala.js with
libraryDependencies += "eu.unicredit" %%% "paths-scala-js" % "0.4.5"
Compatibility
-------------
Paths.scala.js is meant to have an API that is exactly equivalent to its parent library. The only exception is in the `Graph` and `Sankey` charts, where instead of accepting a parameter `data` with `nodes` and `links` fields, the Scala.js API directly requires `nodes` and `links` parameters. This removes one level of nesting and eliminates the need for structural typing in this particular case.
Please, file any other incompatibility between Paths.js and Paths.scala.js as an issue.