You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
+
8
10
## Usage
9
11
10
-
tbd: how to use this lib in your project...
12
+
This npm module already provides all content to use the library immediately: the folder `/src` contains all source files (written in LESS and ES6/ES7), in the folder `/dist` you will find the library, completely ready for use. Now there are two ways to use the library in your npm project:
13
+
14
+
1. You can go the way recommended by [UI5Lab](https://github.com/UI5Lab/UI5Lab-library-simple) which ends up with copying the resources and files from the cloned npm project to your project either manually or via a custom script. We do not recommend that you go this way, because changes to the library must always be copied manually and this variant is more susceptible to errors.
15
+
16
+
1. The way we recommend you is to use our OpenUI5 Starter-Kit for embedding. The prerequisite is that your project uses the build process of the starter kit (see instructions [here](https://github.com/pulseshift/openui5-gulp-starter-kit)). All you have to do then is:
17
+
* Download our library as dev-dependency with `yarn add ui5-lib-visualization --dev`.
18
+
* Add the library to your UI5 build settings in the `package. json`_\*_.
19
+
* Finished, you can now integrate the library into your XML Views via `xmlns: viz="ui5. viz"` or use it in your controllers etc..
20
+
21
+
_\*snipped to include the library via ui5 config in `package. json`:_
Real live samples are beeing published, soon. Till then, please enjoy our first `beta` version of our automatcally created markdown API documentation:
35
+
How to test real live samples please see section `Example`. Till then, please enjoy our first `beta` version of our automatcally created markdown API documentation:
@@ -23,41 +45,120 @@ Real live samples are beeing published, soon. Till then, please enjoy our first
23
45
24
46
### Features
25
47
26
-
tbd: brief overview about the main features...
48
+
_Hint: This overview is not yet complete. In the course of time we will point out all important new functions and add these points to the new demo app, too._
49
+
50
+
A brief overview of features, additional to C3.js line and area charts:
27
51
28
52
### Example
29
53
54
+
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.
55
+
56
+
Here a basic sample of how to use the charts in an XML view:
57
+
58
+
```xml
59
+
<!-- ensure that the series data points and the x-axis labels have the exact same amount of entries -->
Please ensure that you have installed [node](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/en/docs/install) before you continue.
42
139
43
140
Install dependencies:
141
+
44
142
```
45
143
yarn
46
144
```
145
+
47
146
Start developing:
48
147
_Will build all resources start watcher task and start a HTTP server_
148
+
49
149
```
50
150
yarn start
51
151
```
52
152
53
-
The app should open in your browser automatically, otherwise open: `http://localhost:3000`
153
+
The app should open in your browser automatically, otherwise open: `http://localhost:3000/demo/index.html`
54
154
55
155
Info: To get a more detailed logging, use `yarn start:verbose` instead.
56
156
57
157
## Distribution
58
158
59
159
Start build:
60
160
_Will create a `dist` directory in your project root._
161
+
61
162
```
62
163
yarn build
63
164
```
@@ -72,17 +173,15 @@ Contributions, questions and comments are all welcome and encouraged.
72
173
73
174
Check our [current issues](https://github.com/pulseshift/ui5-lib-visualization/issues) or, if you have something in mind how to make it better, [create your own issue](https://github.com/pulseshift/ui5-lib-visualization/issues/new). We would be happy to discuss how they can be solved.
74
175
75
-
### Outlook
176
+
### Contributors
177
+
178
+
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
179
+
180
+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
76
181
77
-
Here is a brief overview on what we are working on right know and what will follow, soon. We are interested to hear your opinion on what should follow next.
182
+
|[<imgsrc="https://avatars1.githubusercontent.com/u/28702172?s=460&v=4"width="100px;"/><br /><sub><b>Lena Serdarusic</b></sub>](https://github.com/lenasrd)<br />[💻](https://github.com/pulseshift/ui5-lib-visualization/commits?author=lenasrd'Code')💡🤔 |[<imgsrc="https://avatars2.githubusercontent.com/u/8706643?s=460&v=4"width="100px;"/><br /><sub><b>Jascha A. Quintern</b></sub>](http://jascha-quintern.de)<br />[💻](https://github.com/pulseshift/ui5-lib-visualization/commits?author=fuchsvomwalde'Code')💬 |
0 commit comments