Skip to content
This repository has been archived by the owner on May 4, 2019. It is now read-only.
Adil edited this page Dec 30, 2013 · 58 revisions

  • You have some list-of-items (mails, digital collections, news, …) that you want to easily get an overview of?
  • Filtering options that feels intuitive, and gives you the right power when needed?
  • Don’t have much screen space for the box, and want to scale easily without losing control?
  • + Simple API to convert data into your interface.

Keshif is here to help you.

Tutorial & Sample Code

Tutorial is here . Using Nobel dataset, first simply import the data with default configurations, then customize for more effective and detailed browsing.

Sample code is below. Keshif only has one main function: kshf.init, and all the configuration is done by modifying the parameters passed to this function.

kshf.init({
    domID : "#chart_div4",
    categoryTextWidth:186,
    source : {
        gdocId : '0Ai6LdDWgaqgNdFhuMXh0V1E2Wk5tU19JaDltUWVMVnc',
        sheets : [ {name:"Posts"} ]
    },
    loadedCb: function(){
        postCols = kshf.dt_ColNames.Posts;
        kshf.cellToArray(kshf.dt.Posts, [postCols.categories], ",", false);
    },
    charts: [ // 2 facets, the first one also describing time chart
        {   facetTitle: "Category",
            timeTitle: "Date"
        },{
            facetTitle: "Author",
            catDispCountFix: 6,
            textFilter: 'by', textGroup: 'authors'
        }
    ],
    sortOpts:{
        sortColWidth: 55,
        columns : [
            {   name: 'Date',
                value: function(d){ return d.data[postCols.date].getUTCFullYear(); }
            }
        ],
        textSearch : 'Title',
        contentFunc : function(d) { 
        	// return an html string which you can generate from the data parameter, d
        }
    }
});

Demos

API Documentation

Main Parameters
Data Source Parameters
Facet Parameters
List Parameters
Notes

Author

Mehmet Adil Yalcin @ HCIL, University of Maryland, College Park

Funded in part by Huawei.