|
5 | 5 |
|
6 | 6 | This library provides an OpenUI5 API that acts as a wrapper for D3-based charting library [C3.js](http://c3js.org/). It offers a more detailed and attractive API design than `sap.viz` chart controls, which interacts harmoniously especially in XML Views in combination with data binding. |
7 | 7 |
|
8 | | -> Furthermore, this project is also a Boilerplate for all UI5 control libraries that rely completely on Open Source and uses 100% internally the same Gulp based build script as our [OpenUI5 Starter Kit](https://github.com/pulseshift/openui5-gulp-starter-kit). One build script to **rule them all**, I mean, how cool is that? Probably pretty cool, at least as long as we haven't found an alternative with Webpack yet. So take a look at our Starter Kit to learn more about the features and functionality of the build process. |
9 | | -
|
10 | 8 | ## Usage |
11 | 9 |
|
12 | 10 | There are two options how to use the chart library in your UI5 project, depending of the project boilerplate you are using. |
@@ -80,14 +78,14 @@ A brief overview of features, additional to C3.js line and area charts: |
80 | 78 |
|
81 | 79 | * Complete API coverage of properties and aggregations for a fully integrated feature set in XML views. |
82 | 80 | * If supported by C3.js, rerender will be avoided by the chart control to ensure smooth transitions in case of changes in the data. |
83 | | -* Support of pins and areas. |
| 81 | +* Support of chart annotations, like lines and areas in various designs. |
84 | 82 | * Support for special designs such as animated dashed lines or hatched areas. |
85 | 83 | * Convergence interval as a new display type of series. |
86 | 84 | * Simple color management by implementing color palettes or individual colors for specific series. |
87 | 85 |
|
88 | 86 | ### Example |
89 | 87 |
|
90 | | -To execute the demo, please follow the instructions described in section `Development`. At the time the demo is being refactored with the goal to provide you an SAP explored like experience. |
| 88 | +To execute the demo, please follow the instructions described in section `Development`. At the time the demo is being refactored with the goal to provide you an _SAP Explore_ like experience. |
91 | 89 |
|
92 | 90 | Here a basic sample of how to use the charts in an XML view: |
93 | 91 |
|
@@ -194,24 +192,23 @@ Info: To get a more detailed logging, use `yarn start:verbose` instead. |
194 | 192 |
|
195 | 193 | ## Distribution |
196 | 194 |
|
197 | | -Start build: |
| 195 | +Start distribution build: |
198 | 196 | _Will create a `dist` directory in your project root._ |
199 | 197 |
|
200 | 198 | ``` |
201 | | -yarn build |
| 199 | +yarn dist |
202 | 200 | ``` |
203 | 201 |
|
204 | | -Afterwards, the production app build can be tested by run `yarn start:dist`. The app should open in your browser automatically, otherwise open: `http://localhost:3000/demo/index.html` |
205 | | - |
206 | | -Info: To get a more detailed logging, use `yarn build:verbose` instead. |
| 202 | +This will build the app, test the code with linters and updates all docs automatically. Afterwards, the production app build can be tested by run `yarn start:dist`. The app should open in your browser automatically, otherwise open: `http://localhost:3000/demo/index.html` |
207 | 203 |
|
208 | | -Publish new version (please use correct [semantic versioning](https://docs.npmjs.com/getting-started/semantic-versioning)): |
209 | | -_Will execute tests, update docs and create a `dist` directory in your project root as prepublish step._ |
| 204 | +If the app build matches your requirements, upload your build to **npm**: |
210 | 205 |
|
211 | 206 | ``` |
212 | 207 | yarn publish |
213 | 208 | ``` |
214 | 209 |
|
| 210 | +_When asket for bumping the version, please use correct [semantic versioning](https://docs.npmjs.com/getting-started/semantic-versioning)._ |
| 211 | + |
215 | 212 | ### Contributing & Troubleshooting |
216 | 213 |
|
217 | 214 | Contributions, questions and comments are all welcome and encouraged. |
|
0 commit comments