From 2b80d7917b400799563afd0f04aa3e200c2af752 Mon Sep 17 00:00:00 2001 From: Tyler Shaddix Date: Sat, 10 Aug 2013 21:03:00 -0700 Subject: [PATCH] Updated README with BAR chart details --- README.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/README.md b/README.md index 21adfbe..566f96c 100644 --- a/README.md +++ b/README.md @@ -229,6 +229,82 @@ You can also easily create Timelines through the HTML Attribute API as well. ``` +##Bar## +A Bar is a Google Visualization [bar chart](https://developers.google.com/chart/interactive/docs/gallery/barchart) which shows metric values over a dimension. + +####Using JS#### + +- `constructor(profile, startDate, endDate)` - The Bar constructor takes in the Google Analytics profile, start date, and end date. All of these parameter options are discussed above in the *Basics* section. +- `addMetric(metric, label)` - Adds the `metric` to the timeline with the name `label`. +- `setDimension(dimension)` - Sets the dimension for the bar chart. +- `setOptions(opts)` - Overwrites any default options for the bar chart. See bar chart options [here](https://developers.google.com/chart/interactive/docs/gallery/barchart#Configuration_Options). `opts` is a simple object, for example: `{ colors : ['#000', '#111', '#222'] }` would assign colors to the timeline. +- `draw(container, callback)` - Calling draw will draw the Timeline into the `container` element. The `container` can either be a `String` of the target element's id, or the DOM element object itself. + +```html + + + + +
+ + + + +``` + +####Using HTML Attributes#### +You can also easily create Bar Charts through the HTML Attribute API as well. + +- `data-oochart` - Should always have value of `bar` for bar charts. +- `data-oochart-start-date` - The beginning date of the data. Can be relative, formatted `YYYY-MM-DD`, or null (indicating current date). +- `data-oochart-end-date` - The ending date of the data. Can be relative, formatted `YYYY-MM-DD`, or null (indicating current date). +- `data-oochart-profile` - The Google Analytics profile ID. +- `data-oochart-metrics` - A list of comma-deliminated metrics in the format: `metric,label,metric,label`. Check out the example below. +- `data-oochart-dimension` - The dimension to group metric values by. + +```html + + + + +
+ + + + + +``` + ##Pie## A Pie chart is really just what it sounds like: A Pie chart. This chart uses the Google Visualization [Pie Chart](https://developers.google.com/chart/interactive/docs/gallery/piechart) to display a metric over a dimension (such as visits by browser type). @@ -446,6 +522,7 @@ You probably want to throw your own styles on the charts, right? You can do this - `oo.setTimelineDefaults(opts)` - Sets the default options of all new Timelines to `opts`. - `oo.setTableDefaults(opts)` - Sets the default options of all new Tables to `opts`. - `oo.setPieDefaults(opts)` - Sets the default options of all new Pies to `opts`. +- `oo.setBarDefaults(opts)` - Sets the default options of all new Bar charts to `opts`. This is especially helpful if you want to stick to the HTML API. Set your defaults before the load call, and all HTML Attribute charts will pick up those defaults.