https://github.com/vaadin-component-factory/vcf-sparkline-renderer
https://github.com/vaadin-component-factory/vcf-sparkline-renderer
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/vcf-sparkline-renderer
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2019-07-05T06:19:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-30T16:28:08.000Z (over 3 years ago)
- Last Synced: 2025-01-10T00:36:32.970Z (4 months ago)
- Language: Java
- Size: 112 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vaadin SparklineRenderer
Vaadin SparklineRenderer is an add-on renderer for Grid (Flow).
### Installing
Add SparklineRenderer to your project
```xml
com.vaadin.componentfactory
vaadin-grid-sparkline-renderer-flow
${project.version}
```
### Using Vaadin SparklineRenderer
[
]()
#### Basic use
```java
public class SparklineRendererDemoView extends DemoView {
private void basicDemo() {
//...
Grid grid = new Grid<>();
grid.addColumn(Song::getName).setHeader("Name").setSortable(true);
grid.addColumn(Song::getArtist).setHeader("Artist").setSortable(true);
grid.setItems(createListOfOneSongs());
// add a column with SparklineRenderer to Grid
grid.addColumn(new SparklineRenderer<>(this::createSparklineValues, song -> new SparklineConfiguration())).setHeader("Daily listeners");
//...
}
private SparklineValues createSparklineValues(Song song) {
// convert existing time series data to a SparklineValues object
return new SparklineValues(song.getDailyListeners().getMeasurements().stream().map(measurement -> new SparklineValues.SparklineValue(measurement.getInstant(), measurement.getValue())).collect(Collectors.toList()));
}
}
```
#### Add PlotBands
```java
public class SparklineRendererDemoView extends DemoView {
private void plotBandDemo() {
//...
grid.addColumn(new SparklineRenderer<>(this::createSparklineValuesTemp, this::createSparklineConfTemp)).setHeader("Body temparature");//...
}
private SparklineConfiguration createSparklineConfTemp(Patient patient) {
return new SparklineConfiguration()
// scale y-axis between min and ax value
.withAutoScaleYAxis(true)
// add a plotband with line color and background color
.withPlotBand(new SparkLinePlotBand(36.0, 38.0)
.withBackgroundColor(SparklineConfiguration.LIGHT_GREEN).withLineColor(Color.GREEN))
// add a plotband with line color
.withPlotBand(new SparkLinePlotBand(38.0, 41.0)
.withLineColor(Color.RED));
}
}
```
## Setting up for development
Clone the project in GitHub (or fork it if you plan on contributing)
```
git clone https://github.com/vaadin/sparkline-renderer.git
```
To build and install the project into the local repository run
```mvn install -DskipITs```
in the root directory. `-DskipITs` will skip the integration tests, which require a TestBench license. If you want to run all tests as part of the build, run
```mvn install```
To compile and run demos locally execute
```
mvn compile
mvn -pl vaadin-component-skeleton-flow-demo -Pwar jetty:run
```
## License & Author
This Add-on is distributed under Apache 2.0
Component Factory Sparkline Renderer is written by Vaadin Ltd.
### Sponsored development
Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: [Support](https://vaadin.com/support) and [Pricing](https://vaadin.com/pricing)