datahub/docs/tutorial-views.markdown

layout, title, recline-deps, root

layout	title	recline-deps	root
container	Library - Example - Quickstart	true	../

Views Tutorial
This step-by-step tutorial will quickly get you started with Recline basics, including creating a dataset from local data and setting up a grid, graph and map to display it.

Preparing your page

Before writing any code with Recline, you need to do the following preparation steps on your page:

1. Download ReclineJS and relevant dependencies.
2. Include the relevant CSS in the head section of your document: {% highlight html %}

{% endhighlight %}

3. Include the relevant Javascript files somewhere on the page (preferably before body close tag): {% highlight html %}

{% endhighlight %}

You're now ready to start working with Recline.

Creating a Dataset

Here's some example data We are going to work with:

{% highlight javascript %} {% include data.js %} {% endhighlight %}

In this data we have 6 documents / rows. Each document is a javascript object containing keys and values (note that all values here are 'simple' but there is no reason you cannot have objects as values allowing you to nest data.

We can now create a recline Dataset object (and memory backend) from this raw data:

{% highlight javascript %} var dataset = new recline.Model.Dataset({ records: data });

//Depending on the view, it may be important to set the date type dataset.fields.models[1].attributes.type = 'date'; {% endhighlight %}

Setting up the Grid

The source code along with all dependencies for the grid part of the tutorial can be found at this GitHub repository. See it in action via GitHub Pages.

Let's create a data grid view to display the dataset we have just created. We're going to use the SlickGrid-based grid so we need the following CSS and JS dependencies in addition to those above:

{% highlight html %}

{% endhighlight %}

Now, let's create an HTML element to for the Grid:

{% highlight html %}

{% endhighlight %}

Now let's set up the Grid:

{% highlight javascript %} var $el = $('#mygrid'); var grid = new recline.View.SlickGrid({ model: dataset, el: $el }); grid.visible = true; grid.render(); {% endhighlight %}

And hey presto:

 

Creating a Graph

The source code along with all dependencies for the graph part of the tutorial can be found at this GitHub repository. See it in action via GitHub Pages.

Let's create a graph view to display a line graph for this dataset.

First, add the additional dependencies for this view. These are the Flot library and the Recline Flot Graph view:

{% highlight html %}

{% endhighlight %}

Next, create a new div for the graph:

{% highlight html %}

{% endhighlight %}

Now let's create the graph, we will use the same dataset we had earlier, and we will need to set the view 'state' in order to configure the graph with the column to use for the x-axis ("group") and the columns to use for the series to show ("series").

State: The concept of a state is a common feature of Recline views being an object which stores information about the state and configuration of a given view. You can read more about it in the general Views documentation as well as the documentation of individual views such as the Graph View.

{% highlight javascript %} var $el = $('#mygraph'); var graph = new recline.View.Graph({ model: dataset, state: { graphType: "lines-and-points", group: "date", series: ["y", "z"] } }); $el.append(graph.el); graph.render(); graph.redraw(); {% endhighlight %}

For the axis date formatting to work, it is crucial that the date type is set for that field as shown in the code concerning the dataset above. The result is the following graph:

 

Creating a Map

The source code along with all dependencies for the map part of the tutorial can be found at this GitHub repository. See it in action via GitHub Pages.

Now, let's create a map of this dataset using the lon/lat information which is present on these data points.

First, add the additional dependencies for the map view. These are the Leaflet library and the Recline Map view:

{% highlight html %}

{% endhighlight %}

Now, create a new div for the map:

{% highlight html %}

{% endhighlight %}

Now let's create the map, we will use the existing dataset object created previously:

{% highlight javascript %} var $el = $('#mymap'); var map = new recline.View.Map({ model: dataset }); $el.append(map.el); map.render(); {% endhighlight %}

 

Creating a Timeline

Now, let's create a timeline for this dataset using the date information which is present on these data points.

First, add the additional dependencies for the timeline view. The timeline is built on the excellent Verite Timeline widget so that library is the key one for this view:

{% highlight html %}

{% endhighlight %}

Now, create a new div for the map (must have an explicit height for the timeline to render):

{% highlight html %}

{% endhighlight %}

Now let's create the timeline, we will use the existing dataset object created previously:

{% highlight javascript %} {% include tutorial-views-timeline.js %} {% endhighlight %}