Skip to content

Commit f632d3b

Browse files
committed
Update README.md
1 parent abce8fa commit f632d3b

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#ZingChart-AngularJS
1+
# ZingChart-AngularJS
22
[![Code Climate](https://codeclimate.com/github/zingchart/ZingChart-AngularJS/badges/gpa.svg)](https://codeclimate.com/github/zingchart/ZingChart-AngularJS) [![Build Status](https://travis-ci.org/zingchart/ZingChart-AngularJS.svg)](https://travis-ci.org/zingchart/ZingChart-AngularJS)
33
---
44
An AngularJS directive for ZingChart to make your charts work dynamically with your data.
55

6-
####Try out our demo! http://zingchart.github.io/ZingChart-AngularJS
7-
6+
#### Try out our demo! http://zingchart.github.io/ZingChart-AngularJS
7+
#### Full blog post @ http://www.zingchart.com/blog/2015/03/05/zingchart-angularjs/
88
## Install
99
```
1010
bower install zingchart-angularjs
@@ -15,7 +15,7 @@ Inject into your app...
1515
var app = angular.module('myApp', ['zingchart-angularjs']);
1616
```
1717

18-
##Usage
18+
## Usage
1919
_javascript_
2020
```js
2121
//In an Angular Controller
@@ -27,21 +27,21 @@ _markup_
2727
<zingchart id="chart-1" zc-values="myValues"></zingchart>
2828
```
2929

30-
##Options
30+
## Options
3131
The ZingChart Component takes the following attributes:
3232

3333

34-
###_zc-id_ [string] ```(required)```
34+
### _zc-id_ [string] ```(required)```
3535
The id for the DOM element for ZingChart to attach to.
36-
#####Example:
36+
##### Example:
3737
```html
3838
<zingchart id="chart-1"></zingchart>
3939
```
4040

4141
---
4242

4343

44-
###_zc-values_ [array] ```(optional)```
44+
### _zc-values_ [array] ```(optional)```
4545
```default : null```
4646

4747
Either a single-dimensional or multi-dimensional array containing the values to be charted. **Must be an Angular scope variable to bind to the directive** Overrides the series values in the zc-render and zc-data objects.
@@ -58,7 +58,7 @@ data:{
5858
```
5959
The directive takes care of the work so you don't have to create this object
6060

61-
#####Example:
61+
##### Example:
6262
```js
6363
//.js
6464
$scope.myData = [0,2,2,3,3,4];
@@ -72,12 +72,12 @@ $scope.myData2 = [[45,43,26],[0,1,5,3]];
7272
---
7373

7474

75-
###_zc-json_ [object] ```(optional)```
75+
### _zc-json_ [object] ```(optional)```
7676
```default : null```
7777

7878
A ZingChart configuration object. **Must be an Angular scope variable to bind to the directive**. This is the same object you would use to configure a chart using zingchart.render.data. It is a pseudo-parent object of zc-values. The directive performs a deep-watch on the object for any changes, and stringifys the result as JSON to be rendered to ZingChart. More information : http://www.zingchart.com/docs/json-attributes-syntax/
7979

80-
#####Example:
80+
##### Example:
8181
http://jsfiddle.net/mschultz/tne7uuq0/
8282
```js
8383
//.js
@@ -113,14 +113,14 @@ Note: You can add series values into this object like you normally would while u
113113
---
114114

115115

116-
###_zc-render_ [object] ```(optional)```
116+
### _zc-render_ [object] ```(optional)```
117117
```default : null```
118118

119119
A ZingChart render object. This is the same object you would use to configure a chart using zingchart.render. You can change the render type, add events, and change other zingchart properties in here. Acts like a pseudo-parent of zc-values and zc-data. zc-render's properties will be overwritten if zc-values and zc-data are defined. More information : http://www.zingchart.com/docs/reference/zingchart-object/#zingchart__render
120120

121121
Note: This object will not be watched inside the directive. It is a one-time setup. While you can insert your data values into the render object directly, it is encouraged to use the zc-values attribute to enable dynamic updating.
122122

123-
#####Example:
123+
##### Example:
124124
```js
125125
//.js
126126
$scope.myValues = [0,1,2];
@@ -138,7 +138,7 @@ $scope.myRender = {
138138
---
139139

140140

141-
###_zc-height_ [number] ```(optional)```
141+
### _zc-height_ [number] ```(optional)```
142142
```default : 400```
143143

144144
Will override the height inside of a zc-render object if defined.
@@ -151,11 +151,11 @@ Will override the height inside of a zc-render object if defined.
151151
---
152152

153153

154-
###_zc-width_ [number] ```(optional)```
154+
### _zc-width_ [number] ```(optional)```
155155
```default : 600```
156156

157157
Will override the width inside of a zc-render object if defined.
158-
#####Example:
158+
##### Example:
159159
```html
160160
//.html
161161
<zingchart id="chart-1" zc-width="500"></zingchart>
@@ -164,11 +164,11 @@ Will override the width inside of a zc-render object if defined.
164164
---
165165

166166

167-
###_zc-type_ [string] ```(optional)```
167+
### _zc-type_ [string] ```(optional)```
168168
```default : line```
169169

170170
Will override the render type inside of a zc-render and zc-data object if defined.
171-
#####Example:
171+
##### Example:
172172
```html
173173
//.html
174174
<zingchart id="chart-1" zc-type="bar"/zingchart>

0 commit comments

Comments
 (0)