Extension View Helpers


Extension Basics

Title
View Helpers
Name
ckanext-viewhelpers
Type
Public extension
Description
Helper methods for CKAN resource views
CKAN versions
Download-Url (zip)
Download-Url commit date
2015-06-01
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

Provides helper methods useful for CKAN’s resource views including data filtering and form generation. Features include OpenSpending-inspired filtering scheme with Key:Value pairs separated by pipes (|), logical OR for same-key filters and AND for different-key filters, filters parameter in URL query strings for dynamic data filtering, filters_form CKAN module for creating filter forms in resource views, support for multiple filters on datasets for focused visualization, and utilities used by ckanext-dashboard, ckanext-basiccharts, and ckanext-mapviews. Designed for the Resource View feature introduced in CKAN 1251-resource-view branch.

Version
0.1
Version release date
2015-06-01
Contact name
Vitor Baptista / Open Knowledge Foundation
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: git clone, python setup.py install, add ‘viewhelpers’ to ckan.plugins BEFORE other plugins that depend on it. No configuration required. Filtering syntax: ?filters=Country:Brazil for single filter, ?filters=Country:Brazil|Country:USA for multiple values (OR), ?filters=Country:Brazil|Year:1990 for multiple keys (AND). Filter form: Use filters_form CKAN module to create forms allowing users to define default filters for resource views. JavaScript tests included. Used by: ckanext-dashboard, ckanext-basiccharts, ckanext-mapviews. Use cases: Interactive data visualization with user-controlled filtering, chart views with multiple data slices, dashboard creation with filtered datasets, geographic visualizations with field-based filters. Note: Designed for CKAN’s Resource View feature from 1251-resource-view branch.

Plugins to configure (ckan.ini)
viewhelpers
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions