Code Monkey home page Code Monkey logo

ckanext-dashboard's Introduction

ckanext-dashboard

Sample dashboard

This extension adds a dashboard to CKAN, which provides way to organize many of the new Resource View being developed in https://github.com/ckan/ckan/tree/1251-resource-view in a single page.

Installation

This extension depends on the latest unreleased CKAN version being worked on the master branch and ckanext-viewhelpers. You have to install that first.

After that, simply clone this repository and run python setup.py install. Then add dashboard_preview to the list in ckan.plugins in your CKAN config file. Make sure to put it after viewhelpers.

Restart your webserver. You should see the new "Dashboard" chart type as an option in the view type's list on any resource.

Usage

First of all, you need to have created the charts that will form the dashboard. Using the sample dashboard above as an example, you'd need a choropleth map (from ckanext-mapviews), a bar chart and a basic grid (both from ckanext-basiccharts) before starting the dashboard.

After you do that, go to the Manage resource page of the resource you want to create the dashboard for, and create a new Dashboard view.

When you start creating a dashboard, before you're able to preview it and add any widgets, you need to decide it's title (you can change it later). Go ahead and write My Dashboard in the title input and click on Preview.

You should see a boring, empty dashboard at the bottom of the page. If you're paying attention, you'd notice that the Add widget and Add widget from URL buttons are now activated. Let's go ahead and start our first widget.

Click on the Add widget button. You should see something similar to:

Add widget dropdown

There you'd see a list of every resource views' that belong to any resource in the current dataset, grouped by resource. Select a few of them.

They'll be added to the dashboard preview in the bottom of the page. There you can resize them simply by dragging their borders, and also reorganize them on the dashboard by dragging and dropping.

If you'd like to allow the user to filter the data, click on Add filter on the Allowed filters field. You can select which columns are filterable (it's only possible to add textual or date columns currently), and change their labels. To understand how the filters work, check ckanext-viewhelpers.

When you're happy with your dashboard, click on Add to save it. You're done! If you go to the resource's page, you should see it.

License

Copyright (C) 2014 Open Knowledge Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

ckanext-dashboard's People

Contributors

johnmartin avatar kindly avatar marks avatar smth avatar tino097 avatar tomecirun avatar vitorbaptista avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ckanext-dashboard's Issues

Filters dont work

I apply filters to my dashboard with just a grid (1251-resource-view branch) but see in the AJAX requests on the dashboard page and in my ckan server logs that no filters were applied to the grid. Excerpt from server log:

2014-05-09 18:55:09,405 DEBUG [ckan.lib.base] Retrieving request params: UnicodeMultiDict([('{"resource_id":"c0d9ab3c-91a3-4fe8-8f54-5d3009e4f01d","q":"","filters":{},"limit":100,"offset":0}', u'')])

I'm looking into how to fix this if I can; any pointers appreciated

API CKAN ERROR USING CKNEXT-DASHBOARD

Hi!

We have an issue with the plugin. We were posting documents through the API using NIFI. Everythings was going well. When we started to use the "ckanext-dashboard" plugin, we start to get internal servers error. (we checked it with the postman). we have just disable the plugin and everything works again.

Does anybody knows hoy to solve this?

Thank u very much

Landscape Dashboard mode

It'd be great if dashboards can be defined for landscape presentation. Right now, when defining a dashboard, you are constrained to a portrait theme.

Typically, dashboards are oriented for landscape presentation because our computer screens are oriented so.

Remove code related to filters' UI

As per CKAN's #1792, this will be done on core. The only thing we need to do is set ourselves as filterable, and support the filters.

Linked filters

Hi,
Could you explain me please how can I change this extensión in order to change the way that filters show options, por example I've three filters, one for countries, another for cities and another one for indicators. I'd like to order filters by a hierarchy Countries, Cities and Indicators. And then for example the filter for cities just show the cities for the country that I chose in Countries filter, and the same with indicators filter.

I'm junior on developting with python and ckan. I hope your soon answer. thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.