this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; this.recline.Backend.CSV = this.recline.Backend.CSV || {}; (function(my) { // ## fetch // // 3 options // // 1. CSV local fileobject -> HTML5 file object + CSV parser // 2. Already have CSV string (in data) attribute -> CSV parser // 2. online CSV file that is ajax-able -> ajax + csv parser // // All options generates similar data and give a memory store outcome my.fetch = function(dataset) { var dfd = $.Deferred(); if (dataset.file) { var reader = new FileReader(); var encoding = dataset.encoding || 'UTF-8'; reader.onload = function(e) { var rows = my.parseCSV(e.target.result, dataset); dfd.resolve({ records: rows, metadata: { filename: dataset.file.name }, useMemoryStore: true }); }; reader.onerror = function (e) { alert('Failed to load file. Code: ' + e.target.error.code); }; reader.readAsText(dataset.file, encoding); } else if (dataset.data) { var rows = my.parseCSV(dataset.data, dataset); dfd.resolve({ records: rows, useMemoryStore: true }); } else if (dataset.url) { $.get(dataset.url).done(function(data) { var rows = my.parseCSV(data, dataset); dfd.resolve({ records: rows, useMemoryStore: true }); }); } return dfd.promise(); }; // Converts a Comma Separated Values string into an array of arrays. // Each line in the CSV becomes an array. // // Empty fields are converted to nulls and non-quoted numbers are converted to integers or floats. // // @return The CSV parsed as an array // @type Array // // @param {String} s The string to convert // @param {Object} options Options for loading CSV including // @param {Boolean} [trim=false] If set to True leading and trailing whitespace is stripped off of each non-quoted field as it is imported // @param {String} [separator=','] Separator for CSV file // Heavily based on uselesscode's JS CSV parser (MIT Licensed): // http://www.uselesscode.org/javascript/csv/ my.parseCSV= function(s, options) { // Get rid of any trailing \n s = chomp(s); var options = options || {}; var trm = (options.trim === false) ? false : true; var separator = options.separator || ','; var delimiter = options.delimiter || '"'; var cur = '', // The character we are currently processing. inQuote = false, fieldQuoted = false, field = '', // Buffer for building up the current field row = [], out = [], i, processField; processField = function (field) { if (fieldQuoted !== true) { // If field is empty set to null if (field === '') { field = null; // If the field was not quoted and we are trimming fields, trim it } else if (trm === true) { field = trim(field); } // Convert unquoted numbers to their appropriate types if (rxIsInt.test(field)) { field = parseInt(field, 10); } else if (rxIsFloat.test(field)) { field = parseFloat(field, 10); } } return field; }; for (i = 0; i < s.length; i += 1) { cur = s.charAt(i); // If we are at a EOF or EOR if (inQuote === false && (cur === separator || cur === "\n")) { field = processField(field); // Add the current field to the current row row.push(field); // If this is EOR append row to output and flush row if (cur === "\n") { out.push(row); row = []; } // Flush the field buffer field = ''; fieldQuoted = false; } else { // If it's not a delimiter, add it to the field buffer if (cur !== delimiter) { field += cur; } else { if (!inQuote) { // We are not in a quote, start a quote inQuote = true; fieldQuoted = true; } else { // Next char is delimiter, this is an escaped delimiter if (s.charAt(i + 1) === delimiter) { field += delimiter; // Skip the next char i += 1; } else { // It's not escaping, so end quote inQuote = false; } } } } } // Add the last field field = processField(field); row.push(field); out.push(row); return out; }; // Converts an array of arrays into a Comma Separated Values string. // Each array becomes a line in the CSV. // // Nulls are converted to empty fields and integers or floats are converted to non-quoted numbers. // // @return The array serialized as a CSV // @type String // // @param {Array} a The array of arrays to convert // @param {Object} options Options for loading CSV including // @param {String} [separator=','] Separator for CSV file // Heavily based on uselesscode's JS CSV parser (MIT Licensed): // http://www.uselesscode.org/javascript/csv/ my.serializeCSV= function(a, options) { var options = options || {}; var separator = options.separator || ','; var delimiter = options.delimiter || '"'; var cur = '', // The character we are currently processing. field = '', // Buffer for building up the current field row = '', out = '', i, j, processField; processField = function (field) { if (field === null) { // If field is null set to empty string field = ''; } else if (typeof field === "string") { // Convert string to delimited string field = delimiter + field + delimiter; } else if (typeof field === "number") { // Convert number to string field = field.toString(10); } return field; }; for (i = 0; i < a.length; i += 1) { cur = a[i]; for (j = 0; j < cur.length; j += 1) { field = processField(cur[j]); // If this is EOR append row to output and flush row if (j === (cur.length - 1)) { row += field; out += row + "\n"; row = ''; } else { // Add the current field to the current row row += field + separator; } // Flush the field buffer field = ''; } } return out; }; var rxHasComma = /^\d+$/, rxIsFloat = /^\d*\.\d+$|^\d+\.\d*$/, // If a string has leading or trailing space, // contains a comma double quote or a newline // it needs to be quoted in CSV output rxNeedsQuoting = /^\s|\s$|,|"|\n/, trim = (function () { // Fx 3.1 has a native trim function, it's about 10x faster, use it if it exists if (String.prototype.trim) { return function (s) { return s.trim(); }; } else { return function (s) { return s.replace(/^\s*/, '').replace(/\s*$/, ''); }; } }()); var rxIsInt = /^\d+$/, rxIsFloat = /^\d*\.\d+$|^\d+\.\d*$/, // If a string has leading or trailing space, // contains a comma double quote or a newline // it needs to be quoted in CSV output rxNeedsQuoting = /^\s|\s$|,|"|\n/, trim = (function () { // Fx 3.1 has a native trim function, it's about 10x faster, use it if it exists if (String.prototype.trim) { return function (s) { return s.trim(); }; } else { return function (s) { return s.replace(/^\s*/, '').replace(/\s*$/, ''); }; } }()); function chomp(s) { if (s.charAt(s.length - 1) !== "\n") { // Does not end with \n, just return string return s; } else { // Remove the \n return s.substring(0, s.length - 1); } } }(this.recline.Backend.CSV)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; this.recline.Backend.DataProxy = this.recline.Backend.DataProxy || {}; (function($, my) { my.__type__ = 'dataproxy'; // URL for the dataproxy my.dataproxy_url = 'http://jsonpdataproxy.appspot.com'; // Timeout for dataproxy (after this time if no response we error) // Needed because use JSONP so do not receive e.g. 500 errors my.timeout = 5000; // ## load // // Load data from a URL via the [DataProxy](http://github.com/okfn/dataproxy). // // Returns array of field names and array of arrays for records my.fetch = function(dataset) { var data = { url: dataset.url, 'max-results': dataset.size || dataset.rows || 1000, type: dataset.format || '' }; var jqxhr = $.ajax({ url: my.dataproxy_url, data: data, dataType: 'jsonp' }); var dfd = $.Deferred(); _wrapInTimeout(jqxhr).done(function(results) { if (results.error) { dfd.reject(results.error); } dfd.resolve({ records: results.data, fields: results.fields, useMemoryStore: true }); }) .fail(function(arguments) { dfd.reject(arguments); }); return dfd.promise(); }; // ## _wrapInTimeout // // Convenience method providing a crude way to catch backend errors on JSONP calls. // Many of backends use JSONP and so will not get error messages and this is // a crude way to catch those errors. var _wrapInTimeout = function(ourFunction) { var dfd = $.Deferred(); var timer = setTimeout(function() { dfd.reject({ message: 'Request Error: Backend did not respond after ' + (my.timeout / 1000) + ' seconds' }); }, my.timeout); ourFunction.done(function(arguments) { clearTimeout(timer); dfd.resolve(arguments); }) .fail(function(arguments) { clearTimeout(timer); dfd.reject(arguments); }) ; return dfd.promise(); } }(jQuery, this.recline.Backend.DataProxy)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {}; (function($, my) { my.__type__ = 'elasticsearch'; // ## ElasticSearch Wrapper // // A simple JS wrapper around an [ElasticSearch](http://www.elasticsearch.org/) endpoints. // // @param {String} endpoint: url for ElasticSearch type/table, e.g. for ES running // on http://localhost:9200 with index twitter and type tweet it would be: // //
http://localhost:9200/twitter/tweet
// // @param {Object} options: set of options such as: // // * headers - {dict of headers to add to each request} // * dataType: dataType for AJAx requests e.g. set to jsonp to make jsonp requests (default is json requests) my.Wrapper = function(endpoint, options) { var self = this; this.endpoint = endpoint; this.options = _.extend({ dataType: 'json' }, options); // ### mapping // // Get ES mapping for this type/table // // @return promise compatible deferred object. this.mapping = function() { var schemaUrl = self.endpoint + '/_mapping'; var jqxhr = makeRequest({ url: schemaUrl, dataType: this.options.dataType }); return jqxhr; }; // ### get // // Get record corresponding to specified id // // @return promise compatible deferred object. this.get = function(id) { var base = this.endpoint + '/' + id; return makeRequest({ url: base, dataType: 'json' }); }; // ### upsert // // create / update a record to ElasticSearch backend // // @param {Object} doc an object to insert to the index. // @return deferred supporting promise API this.upsert = function(doc) { var data = JSON.stringify(doc); url = this.endpoint; if (doc.id) { url += '/' + doc.id; } return makeRequest({ url: url, type: 'POST', data: data, dataType: 'json' }); }; // ### delete // // Delete a record from the ElasticSearch backend. // // @param {Object} id id of object to delete // @return deferred supporting promise API this.delete = function(id) { url = this.endpoint; url += '/' + id; return makeRequest({ url: url, type: 'DELETE', dataType: 'json' }); }; this._normalizeQuery = function(queryObj) { var self = this; var queryInfo = (queryObj && queryObj.toJSON) ? queryObj.toJSON() : _.extend({}, queryObj); var out = { constant_score: { query: {} } }; if (!queryInfo.q) { out.constant_score.query = { match_all: {} }; } else { out.constant_score.query = { query_string: { query: queryInfo.q } }; } if (queryInfo.filters && queryInfo.filters.length) { out.constant_score.filter = { and: [] }; _.each(queryInfo.filters, function(filter) { out.constant_score.filter.and.push(self._convertFilter(filter)); }); } return out; }, this._convertFilter = function(filter) { var out = {}; out[filter.type] = {} if (filter.type === 'term') { out.term[filter.field] = filter.term.toLowerCase(); } else if (filter.type === 'geo_distance') { out.geo_distance[filter.field] = filter.point; out.geo_distance.distance = filter.distance; out.geo_distance.unit = filter.unit; } return out; }, // ### query // // @return deferred supporting promise API this.query = function(queryObj) { var esQuery = (queryObj && queryObj.toJSON) ? queryObj.toJSON() : _.extend({}, queryObj); var queryNormalized = this._normalizeQuery(queryObj); delete esQuery.q; delete esQuery.filters; esQuery.query = queryNormalized; var data = {source: JSON.stringify(esQuery)}; var url = this.endpoint + '/_search'; var jqxhr = makeRequest({ url: url, data: data, dataType: this.options.dataType }); return jqxhr; } }; // ## Recline Connectors // // Requires URL of ElasticSearch endpoint to be specified on the dataset // via the url attribute. // ES options which are passed through to `options` on Wrapper (see Wrapper for details) my.esOptions = {}; // ### fetch my.fetch = function(dataset) { var es = new my.Wrapper(dataset.url, my.esOptions); var dfd = $.Deferred(); es.mapping().done(function(schema) { if (!schema){ dfd.reject({'message':'Elastic Search did not return a mapping'}); return; } // only one top level key in ES = the type so we can ignore it var key = _.keys(schema)[0]; var fieldData = _.map(schema[key].properties, function(dict, fieldName) { dict.id = fieldName; return dict; }); dfd.resolve({ fields: fieldData }); }) .fail(function(arguments) { dfd.reject(arguments); }); return dfd.promise(); }; // ### save my.save = function(changes, dataset) { var es = new my.Wrapper(dataset.url, my.esOptions); if (changes.creates.length + changes.updates.length + changes.deletes.length > 1) { var dfd = $.Deferred(); msg = 'Saving more than one item at a time not yet supported'; alert(msg); dfd.reject(msg); return dfd.promise(); } if (changes.creates.length > 0) { return es.upsert(changes.creates[0]); } else if (changes.updates.length >0) { return es.upsert(changes.updates[0]); } else if (changes.deletes.length > 0) { return es.delete(changes.deletes[0].id); } }; // ### query my.query = function(queryObj, dataset) { var dfd = $.Deferred(); var es = new my.Wrapper(dataset.url, my.esOptions); var jqxhr = es.query(queryObj); jqxhr.done(function(results) { var out = { total: results.hits.total, }; out.hits = _.map(results.hits.hits, function(hit) { if (!('id' in hit._source) && hit._id) { hit._source.id = hit._id; } return hit._source; }); if (results.facets) { out.facets = results.facets; } dfd.resolve(out); }).fail(function(errorObj) { var out = { title: 'Failed: ' + errorObj.status + ' code', message: errorObj.responseText }; dfd.reject(out); }); return dfd.promise(); }; // ### makeRequest // // Just $.ajax but in any headers in the 'headers' attribute of this // Backend instance. Example: // //
// var jqxhr = this._makeRequest({
//   url: the-url
// });
// 
var makeRequest = function(data, headers) { var extras = {}; if (headers) { extras = { beforeSend: function(req) { _.each(headers, function(value, key) { req.setRequestHeader(key, value); }); } }; } var data = _.extend(extras, data); return $.ajax(data); }; }(jQuery, this.recline.Backend.ElasticSearch)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; this.recline.Backend.GDocs = this.recline.Backend.GDocs || {}; (function($, my) { my.__type__ = 'gdocs'; // ## Google spreadsheet backend // // Fetch data from a Google Docs spreadsheet. // // Dataset must have a url attribute pointing to the Gdocs or its JSON feed e.g. //
  // var dataset = new recline.Model.Dataset({
  //     url: 'https://docs.google.com/spreadsheet/ccc?key=0Aon3JiuouxLUdGlQVDJnbjZRSU1tUUJWOUZXRG53VkE#gid=0'
  //   },
  //   'gdocs'
  // );
  //
  // var dataset = new recline.Model.Dataset({
  //     url: 'https://spreadsheets.google.com/feeds/list/0Aon3JiuouxLUdDQwZE1JdV94cUd6NWtuZ0IyWTBjLWc/od6/public/values?alt=json'
  //   },
  //   'gdocs'
  // );
  // 
// // @return object with two attributes // // * fields: array of Field objects // * records: array of objects for each row my.fetch = function(dataset) { var dfd = $.Deferred(); var url = my.getSpreadsheetAPIUrl(dataset.url); $.getJSON(url, function(d) { result = my.parseData(d); var fields = _.map(result.fields, function(fieldId) { return {id: fieldId}; }); dfd.resolve({ records: result.records, fields: fields, useMemoryStore: true }); }); return dfd.promise(); }; // ## parseData // // Parse data from Google Docs API into a reasonable form // // :options: (optional) optional argument dictionary: // columnsToUse: list of columns to use (specified by field names) // colTypes: dictionary (with column names as keys) specifying types (e.g. range, percent for use in conversion). // :return: tabular data object (hash with keys: field and data). // // Issues: seems google docs return columns in rows in random order and not even sure whether consistent across rows. my.parseData = function(gdocsSpreadsheet) { var options = {}; if (arguments.length > 1) { options = arguments[1]; } var results = { fields: [], records: [] }; // default is no special info on type of columns var colTypes = {}; if (options.colTypes) { colTypes = options.colTypes; } if (gdocsSpreadsheet.feed.entry.length > 0) { for (var k in gdocsSpreadsheet.feed.entry[0]) { if (k.substr(0, 3) == 'gsx') { var col = k.substr(4); results.fields.push(col); } } } // converts non numberical values that should be numerical (22.3%[string] -> 0.223[float]) var rep = /^([\d\.\-]+)\%$/; results.records = _.map(gdocsSpreadsheet.feed.entry, function(entry) { var row = {}; _.each(results.fields, function(col) { var _keyname = 'gsx$' + col; var value = entry[_keyname]['$t']; // if labelled as % and value contains %, convert if (colTypes[col] == 'percent') { if (rep.test(value)) { var value2 = rep.exec(value); var value3 = parseFloat(value2); value = value3 / 100; } } row[col] = value; }); return row; }); return results; }; // Convenience function to get GDocs JSON API Url from standard URL my.getSpreadsheetAPIUrl = function(url) { if (url.indexOf('feeds/list') != -1) { return url; } else { // https://docs.google.com/spreadsheet/ccc?key=XXXX#gid=0 var regex = /.*spreadsheet\/ccc?.*key=([^#?&+]+).*/; var matches = url.match(regex); if (matches) { var key = matches[1]; var worksheet = 1; var out = 'https://spreadsheets.google.com/feeds/list/' + key + '/' + worksheet + '/public/values?alt=json'; return out; } else { alert('Failed to extract gdocs key from ' + url); } } }; }(jQuery, this.recline.Backend.GDocs)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; this.recline.Backend.Memory = this.recline.Backend.Memory || {}; (function($, my) { my.__type__ = 'memory'; // ## Data Wrapper // // Turn a simple array of JS objects into a mini data-store with // functionality like querying, faceting, updating (by ID) and deleting (by // ID). // // @param data list of hashes for each record/row in the data ({key: // value, key: value}) // @param fields (optional) list of field hashes (each hash defining a field // as per recline.Model.Field). If fields not specified they will be taken // from the data. my.Store = function(data, fields) { var self = this; this.data = data; if (fields) { this.fields = fields; } else { if (data) { this.fields = _.map(data[0], function(value, key) { return {id: key}; }); } } this.update = function(doc) { _.each(self.data, function(internalDoc, idx) { if(doc.id === internalDoc.id) { self.data[idx] = doc; } }); }; this.delete = function(doc) { var newdocs = _.reject(self.data, function(internalDoc) { return (doc.id === internalDoc.id); }); this.data = newdocs; }; this.save = function(changes, dataset) { var self = this; var dfd = $.Deferred(); // TODO _.each(changes.creates) { ... } _.each(changes.updates, function(record) { self.update(record); }); _.each(changes.deletes, function(record) { self.delete(record); }); dfd.resolve(); return dfd.promise(); }, this.query = function(queryObj) { var dfd = $.Deferred(); var numRows = queryObj.size || this.data.length; var start = queryObj.from || 0; var results = this.data; results = this._applyFilters(results, queryObj); results = this._applyFreeTextQuery(results, queryObj); // not complete sorting! _.each(queryObj.sort, function(sortObj) { var fieldName = _.keys(sortObj)[0]; results = _.sortBy(results, function(doc) { var _out = doc[fieldName]; return _out; }); if (sortObj[fieldName].order == 'desc') { results.reverse(); } }); var facets = this.computeFacets(results, queryObj); var out = { total: results.length, hits: results.slice(start, start+numRows), facets: facets }; dfd.resolve(out); return dfd.promise(); }; // in place filtering this._applyFilters = function(results, queryObj) { _.each(queryObj.filters, function(filter) { // if a term filter ... if (filter.type === 'term') { results = _.filter(results, function(doc) { return (doc[filter.field] == filter.term); }); } }); return results; }; // we OR across fields but AND across terms in query string this._applyFreeTextQuery = function(results, queryObj) { if (queryObj.q) { var terms = queryObj.q.split(' '); results = _.filter(results, function(rawdoc) { var matches = true; _.each(terms, function(term) { var foundmatch = false; _.each(self.fields, function(field) { var value = rawdoc[field.id]; if (value !== null) { value = value.toString(); } else { // value can be null (apparently in some cases) value = ''; } // TODO regexes? foundmatch = foundmatch || (value.toLowerCase() === term.toLowerCase()); // TODO: early out (once we are true should break to spare unnecessary testing) // if (foundmatch) return true; }); matches = matches && foundmatch; // TODO: early out (once false should break to spare unnecessary testing) // if (!matches) return false; }); return matches; }); } return results; }; this.computeFacets = function(records, queryObj) { var facetResults = {}; if (!queryObj.facets) { return facetResults; } _.each(queryObj.facets, function(query, facetId) { // TODO: remove dependency on recline.Model facetResults[facetId] = new recline.Model.Facet({id: facetId}).toJSON(); facetResults[facetId].termsall = {}; }); // faceting _.each(records, function(doc) { _.each(queryObj.facets, function(query, facetId) { var fieldId = query.terms.field; var val = doc[fieldId]; var tmp = facetResults[facetId]; if (val) { tmp.termsall[val] = tmp.termsall[val] ? tmp.termsall[val] + 1 : 1; } else { tmp.missing = tmp.missing + 1; } }); }); _.each(queryObj.facets, function(query, facetId) { var tmp = facetResults[facetId]; var terms = _.map(tmp.termsall, function(count, term) { return { term: term, count: count }; }); tmp.terms = _.sortBy(terms, function(item) { // want descending order return -item.count; }); tmp.terms = tmp.terms.slice(0, 10); }); return facetResults; }; this.transform = function(editFunc) { var toUpdate = recline.Data.Transform.mapDocs(this.data, editFunc); // TODO: very inefficient -- could probably just walk the documents and updates in tandem and update _.each(toUpdate.updates, function(record, idx) { self.data[idx] = record; }); return this.save(toUpdate); }; }; }(jQuery, this.recline.Backend.Memory)); this.recline = this.recline || {}; this.recline.Data = this.recline.Data || {}; (function(my) { // adapted from https://github.com/harthur/costco. heather rules my.Transform = {}; my.Transform.evalFunction = function(funcString) { try { eval("var editFunc = " + funcString); } catch(e) { return {errorMessage: e+""}; } return editFunc; }; my.Transform.previewTransform = function(docs, editFunc, currentColumn) { var preview = []; var updated = my.Transform.mapDocs($.extend(true, {}, docs), editFunc); for (var i = 0; i < updated.docs.length; i++) { var before = docs[i] , after = updated.docs[i] ; if (!after) after = {}; if (currentColumn) { preview.push({before: before[currentColumn], after: after[currentColumn]}); } else { preview.push({before: before, after: after}); } } return preview; }; my.Transform.mapDocs = function(docs, editFunc) { var edited = [] , deleted = [] , failed = [] ; var updatedDocs = _.map(docs, function(doc) { try { var updated = editFunc(_.clone(doc)); } catch(e) { failed.push(doc); return; } if(updated === null) { updated = {_deleted: true}; edited.push(updated); deleted.push(doc); } else if(updated && !_.isEqual(updated, doc)) { edited.push(updated); } return updated; }); return { updates: edited, docs: updatedDocs, deletes: deleted, failed: failed }; }; }(this.recline.Data)) // # Recline Backbone Models this.recline = this.recline || {}; this.recline.Model = this.recline.Model || {}; (function($, my) { // ## Dataset my.Dataset = Backbone.Model.extend({ constructor: function Dataset() { Backbone.Model.prototype.constructor.apply(this, arguments); }, // ### initialize initialize: function() { _.bindAll(this, 'query'); this.backend = null; if (this.get('backend')) { this.backend = this._backendFromString(this.get('backend')); } else { // try to guess backend ... if (this.get('records')) { this.backend = recline.Backend.Memory; } } this.fields = new my.FieldList(); this.records = new my.RecordList(); this._changes = { deletes: [], updates: [], creates: [] }; this.facets = new my.FacetList(); this.recordCount = null; this.queryState = new my.Query(); this.queryState.bind('change', this.query); this.queryState.bind('facet:add', this.query); // store is what we query and save against // store will either be the backend or be a memory store if Backend fetch // tells us to use memory store this._store = this.backend; if (this.backend == recline.Backend.Memory) { this.fetch(); } }, // ### fetch // // Retrieve dataset and (some) records from the backend. fetch: function() { var self = this; var dfd = $.Deferred(); if (this.backend !== recline.Backend.Memory) { this.backend.fetch(this.toJSON()) .done(handleResults) .fail(function(arguments) { dfd.reject(arguments); }); } else { // special case where we have been given data directly handleResults({ records: this.get('records'), fields: this.get('fields'), useMemoryStore: true }); } function handleResults(results) { var out = self._normalizeRecordsAndFields(results.records, results.fields); if (results.useMemoryStore) { self._store = new recline.Backend.Memory.Store(out.records, out.fields); } self.set(results.metadata); self.fields.reset(out.fields); self.query() .done(function() { dfd.resolve(self); }) .fail(function(arguments) { dfd.reject(arguments); }); } return dfd.promise(); }, // ### _normalizeRecordsAndFields // // Get a proper set of fields and records from incoming set of fields and records either of which may be null or arrays or objects // // e.g. fields = ['a', 'b', 'c'] and records = [ [1,2,3] ] => // fields = [ {id: a}, {id: b}, {id: c}], records = [ {a: 1}, {b: 2}, {c: 3}] _normalizeRecordsAndFields: function(records, fields) { // if no fields get them from records if (!fields && records && records.length > 0) { // records is array then fields is first row of records ... if (records[0] instanceof Array) { fields = records[0]; records = records.slice(1); } else { fields = _.map(_.keys(records[0]), function(key) { return {id: key}; }); } } // fields is an array of strings (i.e. list of field headings/ids) if (fields && fields.length > 0 && typeof fields[0] === 'string') { // Rename duplicate fieldIds as each field name needs to be // unique. var seen = {}; fields = _.map(fields, function(field, index) { // cannot use trim as not supported by IE7 var fieldId = field.replace(/^\s+|\s+$/g, ''); if (fieldId === '') { fieldId = '_noname_'; field = fieldId; } while (fieldId in seen) { seen[field] += 1; fieldId = field + seen[field]; } if (!(field in seen)) { seen[field] = 0; } // TODO: decide whether to keep original name as label ... // return { id: fieldId, label: field || fieldId } return { id: fieldId }; }); } // records is provided as arrays so need to zip together with fields // NB: this requires you to have fields to match arrays if (records && records.length > 0 && records[0] instanceof Array) { records = _.map(records, function(doc) { var tmp = {}; _.each(fields, function(field, idx) { tmp[field.id] = doc[idx]; }); return tmp; }); } return { fields: fields, records: records }; }, save: function() { var self = this; // TODO: need to reset the changes ... return this._store.save(this._changes, this.toJSON()); }, transform: function(editFunc) { var self = this; if (!this._store.transform) { alert('Transform is not supported with this backend: ' + this.get('backend')); return; } this.trigger('recline:flash', {message: "Updating all visible docs. This could take a while...", persist: true, loader: true}); this._store.transform(editFunc).done(function() { // reload data as records have changed self.query(); self.trigger('recline:flash', {message: "Records updated successfully"}); }); }, // ### query // // AJAX method with promise API to get records from the backend. // // It will query based on current query state (given by this.queryState) // updated by queryObj (if provided). // // Resulting RecordList are used to reset this.records and are // also returned. query: function(queryObj) { var self = this; var dfd = $.Deferred(); this.trigger('query:start'); if (queryObj) { this.queryState.set(queryObj, {silent: true}); } var actualQuery = this.queryState.toJSON(); this._store.query(actualQuery, this.toJSON()) .done(function(queryResult) { self._handleQueryResult(queryResult); self.trigger('query:done'); dfd.resolve(self.records); }) .fail(function(arguments) { self.trigger('query:fail', arguments); dfd.reject(arguments); }); return dfd.promise(); }, _handleQueryResult: function(queryResult) { var self = this; self.recordCount = queryResult.total; var docs = _.map(queryResult.hits, function(hit) { var _doc = new my.Record(hit); _doc.fields = self.fields; _doc.bind('change', function(doc) { self._changes.updates.push(doc.toJSON()); }); _doc.bind('destroy', function(doc) { self._changes.deletes.push(doc.toJSON()); }); return _doc; }); self.records.reset(docs); if (queryResult.facets) { var facets = _.map(queryResult.facets, function(facetResult, facetId) { facetResult.id = facetId; return new my.Facet(facetResult); }); self.facets.reset(facets); } }, toTemplateJSON: function() { var data = this.toJSON(); data.recordCount = this.recordCount; data.fields = this.fields.toJSON(); return data; }, // ### getFieldsSummary // // Get a summary for each field in the form of a `Facet`. // // @return null as this is async function. Provides deferred/promise interface. getFieldsSummary: function() { var self = this; var query = new my.Query(); query.set({size: 0}); this.fields.each(function(field) { query.addFacet(field.id); }); var dfd = $.Deferred(); this._store.query(query.toJSON(), this.toJSON()).done(function(queryResult) { if (queryResult.facets) { _.each(queryResult.facets, function(facetResult, facetId) { facetResult.id = facetId; var facet = new my.Facet(facetResult); // TODO: probably want replace rather than reset (i.e. just replace the facet with this id) self.fields.get(facetId).facets.reset(facet); }); } dfd.resolve(queryResult); }); return dfd.promise(); }, // Deprecated (as of v0.5) - use record.summary() recordSummary: function(record) { return record.summary(); }, // ### _backendFromString(backendString) // // See backend argument to initialize for details _backendFromString: function(backendString) { var parts = backendString.split('.'); // walk through the specified path xxx.yyy.zzz to get the final object which should be backend class var current = window; for(ii=0;ii // { // backend: {backend type - i.e. value of dataset.backend.__type__} // dataset: {dataset info needed for loading -- result of dataset.toJSON() would be sufficient but can be simpler } // // convenience - if url provided and dataste not this be used as dataset url // url: {dataset url} // ... // } my.Dataset.restore = function(state) { var dataset = null; // hack-y - restoring a memory dataset does not mean much ... if (state.backend === 'memory') { var datasetInfo = { records: [{stub: 'this is a stub dataset because we do not restore memory datasets'}] }; } else { var datasetInfo = { url: state.url, backend: state.backend }; } dataset = new recline.Model.Dataset(datasetInfo); return dataset; }; // ## A Record // // A single record (or row) in the dataset my.Record = Backbone.Model.extend({ constructor: function Record() { Backbone.Model.prototype.constructor.apply(this, arguments); }, // ### initialize // // Create a Record // // You usually will not do this directly but will have records created by // Dataset e.g. in query method // // Certain methods require presence of a fields attribute (identical to that on Dataset) initialize: function() { _.bindAll(this, 'getFieldValue'); }, // ### getFieldValue // // For the provided Field get the corresponding rendered computed data value // for this record. getFieldValue: function(field) { val = this.getFieldValueUnrendered(field); if (field.renderer) { val = field.renderer(val, field, this.toJSON()); } return val; }, // ### getFieldValueUnrendered // // For the provided Field get the corresponding computed data value // for this record. getFieldValueUnrendered: function(field) { var val = this.get(field.id); if (field.deriver) { val = field.deriver(val, field, this); } return val; }, // ### summary // // Get a simple html summary of this record in form of key/value list summary: function(record) { var self = this; var html = '
'; this.fields.each(function(field) { if (field.id != 'id') { html += '
' + field.get('label') + ': ' + self.getFieldValue(field) + '
'; } }); html += '
'; return html; }, // Override Backbone save, fetch and destroy so they do nothing // Instead, Dataset object that created this Record should take care of // handling these changes (discovery will occur via event notifications) // WARNING: these will not persist *unless* you call save on Dataset fetch: function() {}, save: function() {}, destroy: function() { this.trigger('destroy', this); } }); // ## A Backbone collection of Records my.RecordList = Backbone.Collection.extend({ constructor: function RecordList() { Backbone.Collection.prototype.constructor.apply(this, arguments); }, model: my.Record }); // ## A Field (aka Column) on a Dataset my.Field = Backbone.Model.extend({ constructor: function Field() { Backbone.Model.prototype.constructor.apply(this, arguments); }, // ### defaults - define default values defaults: { label: null, type: 'string', format: null, is_derived: false }, // ### initialize // // @param {Object} data: standard Backbone model attributes // // @param {Object} options: renderer and/or deriver functions. initialize: function(data, options) { // if a hash not passed in the first argument throw error if ('0' in data) { throw new Error('Looks like you did not pass a proper hash with id to Field constructor'); } if (this.attributes.label === null) { this.set({label: this.id}); } if (options) { this.renderer = options.renderer; this.deriver = options.deriver; } if (!this.renderer) { this.renderer = this.defaultRenderers[this.get('type')]; } this.facets = new my.FacetList(); }, defaultRenderers: { object: function(val, field, doc) { return JSON.stringify(val); }, geo_point: function(val, field, doc) { return JSON.stringify(val); }, 'float': function(val, field, doc) { var format = field.get('format'); if (format === 'percentage') { return val + '%'; } return val; }, 'string': function(val, field, doc) { var format = field.get('format'); if (format === 'markdown') { if (typeof Showdown !== 'undefined') { var showdown = new Showdown.converter(); out = showdown.makeHtml(val); return out; } else { return val; } } else if (format == 'plain') { return val; } else { // as this is the default and default type is string may get things // here that are not actually strings if (val && typeof val === 'string') { val = val.replace(/(https?:\/\/[^ ]+)/g, '$1'); } return val } } } }); my.FieldList = Backbone.Collection.extend({ constructor: function FieldList() { Backbone.Collection.prototype.constructor.apply(this, arguments); }, model: my.Field }); // ## Query my.Query = Backbone.Model.extend({ constructor: function Query() { Backbone.Model.prototype.constructor.apply(this, arguments); }, defaults: function() { return { size: 100, from: 0, q: '', facets: {}, filters: [] }; }, _filterTemplates: { term: { type: 'term', field: '', term: '' }, geo_distance: { distance: 10, unit: 'km', point: { lon: 0, lat: 0 } } }, // ### addFilter // // Add a new filter (appended to the list of filters) // // @param filter an object specifying the filter - see _filterTemplates for examples. If only type is provided will generate a filter by cloning _filterTemplates addFilter: function(filter) { // crude deep copy var ourfilter = JSON.parse(JSON.stringify(filter)); // not full specified so use template and over-write if (_.keys(filter).length <= 2) { ourfilter = _.extend(this._filterTemplates[filter.type], ourfilter); } var filters = this.get('filters'); filters.push(ourfilter); this.trigger('change:filters:new-blank'); }, updateFilter: function(index, value) { }, // ### removeFilter // // Remove a filter from filters at index filterIndex removeFilter: function(filterIndex) { var filters = this.get('filters'); filters.splice(filterIndex, 1); this.set({filters: filters}); this.trigger('change'); }, // ### addFacet // // Add a Facet to this query // // See addFacet: function(fieldId) { var facets = this.get('facets'); // Assume id and fieldId should be the same (TODO: this need not be true if we want to add two different type of facets on same field) if (_.contains(_.keys(facets), fieldId)) { return; } facets[fieldId] = { terms: { field: fieldId } }; this.set({facets: facets}, {silent: true}); this.trigger('facet:add', this); }, addHistogramFacet: function(fieldId) { var facets = this.get('facets'); facets[fieldId] = { date_histogram: { field: fieldId, interval: 'day' } }; this.set({facets: facets}, {silent: true}); this.trigger('facet:add', this); } }); // ## A Facet (Result) my.Facet = Backbone.Model.extend({ constructor: function Facet() { Backbone.Model.prototype.constructor.apply(this, arguments); }, defaults: function() { return { _type: 'terms', total: 0, other: 0, missing: 0, terms: [] }; } }); // ## A Collection/List of Facets my.FacetList = Backbone.Collection.extend({ constructor: function FacetList() { Backbone.Collection.prototype.constructor.apply(this, arguments); }, model: my.Facet }); // ## Object State // // Convenience Backbone model for storing (configuration) state of objects like Views. my.ObjectState = Backbone.Model.extend({ }); // ## Backbone.sync // // Override Backbone.sync to hand off to sync function in relevant backend Backbone.sync = function(method, model, options) { return model.backend.sync(method, model, options); }; }(jQuery, this.recline.Model)); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## Graph view for a Dataset using Flot graphing library. // // Initialization arguments (in a hash in first parameter): // // * model: recline.Model.Dataset // * state: (optional) configuration hash of form: // // { // group: {column name for x-axis}, // series: [{column name for series A}, {column name series B}, ... ], // graphType: 'line' // } // // NB: should *not* provide an el argument to the view but must let the view // generate the element itself (you can then append view.el to the DOM. my.Graph = Backbone.View.extend({ tagName: "div", className: "recline-graph", template: ' \
\
\

Hey there!

\

There\'s no graph here yet because we don\'t know what fields you\'d like to see plotted.

\

Please tell us by using the menu on the right and a graph will automatically appear.

\
\
\ \ ', initialize: function(options) { var self = this; this.el = $(this.el); _.bindAll(this, 'render', 'redraw'); this.needToRedraw = false; this.model.bind('change', this.render); this.model.fields.bind('reset', this.render); this.model.fields.bind('add', this.render); this.model.records.bind('add', this.redraw); this.model.records.bind('reset', this.redraw); // because we cannot redraw when hidden we may need when becoming visible this.bind('view:show', function() { if (this.needToRedraw) { self.redraw(); } }); var stateData = _.extend({ group: null, // so that at least one series chooser box shows up series: [], graphType: 'lines-and-points' }, options.state ); this.state = new recline.Model.ObjectState(stateData); this.editor = new my.GraphControls({ model: this.model, state: this.state.toJSON() }); this.editor.state.bind('change', function() { self.state.set(self.editor.state.toJSON()); self.redraw(); }); this.elSidebar = this.editor.el; this.render(); }, render: function() { var self = this; var tmplData = this.model.toTemplateJSON(); var htmls = Mustache.render(this.template, tmplData); $(this.el).html(htmls); this.$graph = this.el.find('.panel.graph'); return this; }, redraw: function() { // There appear to be issues generating a Flot graph if either: // * The relevant div that graph attaches to his hidden at the moment of creating the plot -- Flot will complain with // // Uncaught Invalid dimensions for plot, width = 0, height = 0 // * There is no data for the plot -- either same error or may have issues later with errors like 'non-existent node-value' var areWeVisible = !jQuery.expr.filters.hidden(this.el[0]); if ((!areWeVisible || this.model.records.length === 0)) { this.needToRedraw = true; return; } // check we have something to plot if (this.state.get('group') && this.state.get('series')) { // faff around with width because flot draws axes *outside* of the element width which means graph can get push down as it hits element next to it this.$graph.width(this.el.width() - 20); var series = this.createSeries(); var options = this.getGraphOptions(this.state.attributes.graphType); this.plot = $.plot(this.$graph, series, options); this.setupTooltips(); } }, // ### getGraphOptions // // Get options for Flot Graph // // needs to be function as can depend on state // // @param typeId graphType id (lines, lines-and-points etc) getGraphOptions: function(typeId) { var self = this; // special tickformatter to show labels rather than numbers // TODO: we should really use tickFormatter and 1 interval ticks if (and // only if) x-axis values are non-numeric // However, that is non-trivial to work out from a dataset (datasets may // have no field type info). Thus at present we only do this for bars. var tickFormatter = function (val) { if (self.model.records.models[val]) { var out = self.model.records.models[val].get(self.state.attributes.group); // if the value was in fact a number we want that not the if (typeof(out) == 'number') { return val; } else { return out; } } return val; }; var xaxis = {}; // check for time series on x-axis if (this.model.fields.get(this.state.get('group')).get('type') === 'date') { xaxis.mode = 'time'; xaxis.timeformat = '%y-%b'; } var optionsPerGraphType = { lines: { series: { lines: { show: true } }, xaxis: xaxis }, points: { series: { points: { show: true } }, xaxis: xaxis, grid: { hoverable: true, clickable: true } }, 'lines-and-points': { series: { points: { show: true }, lines: { show: true } }, xaxis: xaxis, grid: { hoverable: true, clickable: true } }, bars: { series: { lines: {show: false}, bars: { show: true, barWidth: 1, align: "center", fill: true, horizontal: true } }, grid: { hoverable: true, clickable: true }, yaxis: { tickSize: 1, tickLength: 1, tickFormatter: tickFormatter, min: -0.5, max: self.model.records.length - 0.5 } } }; return optionsPerGraphType[typeId]; }, setupTooltips: function() { var self = this; function showTooltip(x, y, contents) { $('
' + contents + '
').css( { position: 'absolute', display: 'none', top: y + 5, left: x + 5, border: '1px solid #fdd', padding: '2px', 'background-color': '#fee', opacity: 0.80 }).appendTo("body").fadeIn(200); } var previousPoint = null; this.$graph.bind("plothover", function (event, pos, item) { if (item) { if (previousPoint != item.datapoint) { previousPoint = item.datapoint; $("#flot-tooltip").remove(); var x = item.datapoint[0]; var y = item.datapoint[1]; // it's horizontal so we have to flip if (self.state.attributes.graphType === 'bars') { var _tmp = x; x = y; y = _tmp; } // convert back from 'index' value on x-axis (e.g. in cases where non-number values) if (self.model.records.models[x]) { x = self.model.records.models[x].get(self.state.attributes.group); } else { x = x.toFixed(2); } y = y.toFixed(2); // is it time series var xfield = self.model.fields.get(self.state.attributes.group); var isDateTime = xfield.get('type') === 'date'; if (isDateTime) { x = new Date(parseInt(x)).toLocaleDateString(); } var content = _.template('<%= group %> = <%= x %>, <%= series %> = <%= y %>', { group: self.state.attributes.group, x: x, series: item.series.label, y: y }); showTooltip(item.pageX, item.pageY, content); } } else { $("#flot-tooltip").remove(); previousPoint = null; } }); }, createSeries: function () { var self = this; var series = []; _.each(this.state.attributes.series, function(field) { var points = []; _.each(self.model.records.models, function(doc, index) { var xfield = self.model.fields.get(self.state.attributes.group); var x = doc.getFieldValue(xfield); // time series var isDateTime = xfield.get('type') === 'date'; if (isDateTime) { x = moment(x).toDate(); } var yfield = self.model.fields.get(field); var y = doc.getFieldValue(yfield); if (typeof x === 'string') { x = parseFloat(x); if (isNaN(x)) { x = index; } } // horizontal bar chart if (self.state.attributes.graphType == 'bars') { points.push([y, x]); } else { points.push([x, y]); } }); series.push({data: points, label: field}); }); return series; } }); my.GraphControls = Backbone.View.extend({ className: "editor", template: ' \
\
\
\ \
\ \
\ \
\ \
\
\
\
\
\ \
\ \
\
\ ', templateSeriesEditor: ' \
\ \
\ \
\
\ ', events: { 'change form select': 'onEditorSubmit', 'click .editor-add': '_onAddSeries', 'click .action-remove-series': 'removeSeries' }, initialize: function(options) { var self = this; this.el = $(this.el); _.bindAll(this, 'render'); this.model.fields.bind('reset', this.render); this.model.fields.bind('add', this.render); this.state = new recline.Model.ObjectState(options.state); this.render(); }, render: function() { var self = this; var tmplData = this.model.toTemplateJSON(); var htmls = Mustache.render(this.template, tmplData); this.el.html(htmls); // set up editor from state if (this.state.get('graphType')) { this._selectOption('.editor-type', this.state.get('graphType')); } if (this.state.get('group')) { this._selectOption('.editor-group', this.state.get('group')); } // ensure at least one series box shows up var tmpSeries = [""]; if (this.state.get('series').length > 0) { tmpSeries = this.state.get('series'); } _.each(tmpSeries, function(series, idx) { self.addSeries(idx); self._selectOption('.editor-series.js-series-' + idx, series); }); return this; }, // Private: Helper function to select an option from a select list // _selectOption: function(id,value){ var options = this.el.find(id + ' select > option'); if (options) { options.each(function(opt){ if (this.value == value) { $(this).attr('selected','selected'); return false; } }); } }, onEditorSubmit: function(e) { var select = this.el.find('.editor-group select'); var $editor = this; var $series = this.el.find('.editor-series select'); var series = $series.map(function () { return $(this).val(); }); var updatedState = { series: $.makeArray(series), group: this.el.find('.editor-group select').val(), graphType: this.el.find('.editor-type select').val() }; this.state.set(updatedState); }, // Public: Adds a new empty series select box to the editor. // // @param [int] idx index of this series in the list of series // // Returns itself. addSeries: function (idx) { var data = _.extend({ seriesIndex: idx, seriesName: String.fromCharCode(idx + 64 + 1), }, this.model.toTemplateJSON()); var htmls = Mustache.render(this.templateSeriesEditor, data); this.el.find('.editor-series-group').append(htmls); return this; }, _onAddSeries: function(e) { e.preventDefault(); this.addSeries(this.state.get('series').length); }, // Public: Removes a series list item from the editor. // // Also updates the labels of the remaining series elements. removeSeries: function (e) { e.preventDefault(); var $el = $(e.target); $el.parent().parent().remove(); this.onEditorSubmit(); } }); })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## (Data) Grid Dataset View // // Provides a tabular view on a Dataset. // // Initialize it with a `recline.Model.Dataset`. my.Grid = Backbone.View.extend({ tagName: "div", className: "recline-grid-container", initialize: function(modelEtc) { var self = this; this.el = $(this.el); _.bindAll(this, 'render', 'onHorizontalScroll'); this.model.records.bind('add', this.render); this.model.records.bind('reset', this.render); this.model.records.bind('remove', this.render); this.tempState = {}; var state = _.extend({ hiddenFields: [] }, modelEtc.state ); this.state = new recline.Model.ObjectState(state); }, events: { // does not work here so done at end of render function // 'scroll .recline-grid tbody': 'onHorizontalScroll' }, // ====================================================== // Column and row menus setColumnSort: function(order) { var sort = [{}]; sort[0][this.tempState.currentColumn] = {order: order}; this.model.query({sort: sort}); }, hideColumn: function() { var hiddenFields = this.state.get('hiddenFields'); hiddenFields.push(this.tempState.currentColumn); this.state.set({hiddenFields: hiddenFields}); // change event not being triggered (because it is an array?) so trigger manually this.state.trigger('change'); this.render(); }, showColumn: function(e) { var hiddenFields = _.without(this.state.get('hiddenFields'), $(e.target).data('column')); this.state.set({hiddenFields: hiddenFields}); this.render(); }, onHorizontalScroll: function(e) { var currentScroll = $(e.target).scrollLeft(); this.el.find('.recline-grid thead tr').scrollLeft(currentScroll); }, // ====================================================== // #### Templating template: ' \
\ \ \ \ {{#fields}} \ \ {{/fields}} \ \ \ \ \
\ {{label}} \
\
\ ', toTemplateJSON: function() { var self = this; var modelData = this.model.toJSON(); modelData.notEmpty = ( this.fields.length > 0 ); // TODO: move this sort of thing into a toTemplateJSON method on Dataset? modelData.fields = _.map(this.fields, function(field) { return field.toJSON(); }); // last header width = scroll bar - border (2px) */ modelData.lastHeaderWidth = this.scrollbarDimensions.width - 2; return modelData; }, render: function() { var self = this; this.fields = this.model.fields.filter(function(field) { return _.indexOf(self.state.get('hiddenFields'), field.id) == -1; }); this.scrollbarDimensions = this.scrollbarDimensions || this._scrollbarSize(); // skip measurement if already have dimensions var numFields = this.fields.length; // compute field widths (-20 for first menu col + 10px for padding on each col and finally 16px for the scrollbar) var fullWidth = self.el.width() - 20 - 10 * numFields - this.scrollbarDimensions.width; var width = parseInt(Math.max(50, fullWidth / numFields)); // if columns extend outside viewport then remainder is 0 var remainder = Math.max(fullWidth - numFields * width,0); _.each(this.fields, function(field, idx) { // add the remainder to the first field width so we make up full col if (idx == 0) { field.set({width: width+remainder}); } else { field.set({width: width}); } }); var htmls = Mustache.render(this.template, this.toTemplateJSON()); this.el.html(htmls); this.model.records.forEach(function(doc) { var tr = $(''); self.el.find('tbody').append(tr); var newView = new my.GridRow({ model: doc, el: tr, fields: self.fields }); newView.render(); }); // hide extra header col if no scrollbar to avoid unsightly overhang var $tbody = this.el.find('tbody')[0]; if ($tbody.scrollHeight <= $tbody.offsetHeight) { this.el.find('th.last-header').hide(); } this.el.find('.recline-grid').toggleClass('no-hidden', (self.state.get('hiddenFields').length === 0)); this.el.find('.recline-grid tbody').scroll(this.onHorizontalScroll); return this; }, // ### _scrollbarSize // // Measure width of a vertical scrollbar and height of a horizontal scrollbar. // // @return: { width: pixelWidth, height: pixelHeight } _scrollbarSize: function() { var $c = $("
").appendTo("body"); var dim = { width: $c.width() - $c[0].clientWidth + 1, height: $c.height() - $c[0].clientHeight }; $c.remove(); return dim; } }); // ## GridRow View for rendering an individual record. // // Since we want this to update in place it is up to creator to provider the element to attach to. // // In addition you *must* pass in a FieldList in the constructor options. This should be list of fields for the Grid. // // Example: // //
// var row = new GridRow({
//   model: dataset-record,
//     el: dom-element,
//     fields: mydatasets.fields // a FieldList object
//   });
// 
my.GridRow = Backbone.View.extend({ initialize: function(initData) { _.bindAll(this, 'render'); this._fields = initData.fields; this.el = $(this.el); this.model.bind('change', this.render); }, template: ' \ {{#cells}} \ \
\   \
{{{value}}}
\
\ \ {{/cells}} \ ', events: { 'click .data-table-cell-edit': 'onEditClick', 'click .data-table-cell-editor .okButton': 'onEditorOK', 'click .data-table-cell-editor .cancelButton': 'onEditorCancel' }, toTemplateJSON: function() { var self = this; var doc = this.model; var cellData = this._fields.map(function(field) { return { field: field.id, width: field.get('width'), value: doc.getFieldValue(field) }; }); return { id: this.id, cells: cellData }; }, render: function() { this.el.attr('data-id', this.model.id); var html = Mustache.render(this.template, this.toTemplateJSON()); $(this.el).html(html); return this; }, // =================== // Cell Editor methods cellEditorTemplate: ' \ \ ', onEditClick: function(e) { var editing = this.el.find('.data-table-cell-editor-editor'); if (editing.length > 0) { editing.parents('.data-table-cell-value').html(editing.text()).siblings('.data-table-cell-edit').removeClass("hidden"); } $(e.target).addClass("hidden"); var cell = $(e.target).siblings('.data-table-cell-value'); cell.data("previousContents", cell.text()); var templated = Mustache.render(this.cellEditorTemplate, {value: cell.text()}); cell.html(templated); }, onEditorOK: function(e) { var self = this; var cell = $(e.target); var rowId = cell.parents('tr').attr('data-id'); var field = cell.parents('td').attr('data-field'); var newValue = cell.parents('.data-table-cell-editor').find('.data-table-cell-editor-editor').val(); var newData = {}; newData[field] = newValue; this.model.set(newData); this.trigger('recline:flash', {message: "Updating row...", loader: true}); this.model.save().then(function(response) { this.trigger('recline:flash', {message: "Row updated successfully", category: 'success'}); }) .fail(function() { this.trigger('recline:flash', { message: 'Error saving row', category: 'error', persist: true }); }); }, onEditorCancel: function(e) { var cell = $(e.target).parents('.data-table-cell-value'); cell.html(cell.data('previousContents')).siblings('.data-table-cell-edit').removeClass("hidden"); } }); })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## Map view for a Dataset using Leaflet mapping library. // // This view allows to plot gereferenced records on a map. The location // information can be provided either via a field with // [GeoJSON](http://geojson.org) objects or two fields with latitude and // longitude coordinates. // // Initialization arguments are as standard for Dataset Views. State object may // have the following (optional) configuration options: // //
//   {
//     // geomField if specified will be used in preference to lat/lon
//     geomField: {id of field containing geometry in the dataset}
//     lonField: {id of field containing longitude in the dataset}
//     latField: {id of field containing latitude in the dataset}
//   }
// 
my.Map = Backbone.View.extend({ tagName: 'div', className: 'recline-map', template: ' \
\ ', // These are the default (case-insensitive) names of field that are used if found. // If not found, the user will need to define the fields via the editor. latitudeFieldNames: ['lat','latitude'], longitudeFieldNames: ['lon','longitude'], geometryFieldNames: ['geojson', 'geom','the_geom','geometry','spatial','location', 'geo', 'lonlat'], initialize: function(options) { var self = this; this.el = $(this.el); // Listen to changes in the fields this.model.fields.bind('change', function() { self._setupGeometryField() self.render() }); // Listen to changes in the records this.model.records.bind('add', function(doc){self.redraw('add',doc)}); this.model.records.bind('change', function(doc){ self.redraw('remove',doc); self.redraw('add',doc); }); this.model.records.bind('remove', function(doc){self.redraw('remove',doc)}); this.model.records.bind('reset', function(){self.redraw('reset')}); this.bind('view:show',function(){ // If the div was hidden, Leaflet needs to recalculate some sizes // to display properly if (self.map){ self.map.invalidateSize(); if (self._zoomPending && self.state.get('autoZoom')) { self._zoomToFeatures(); self._zoomPending = false; } } self.visible = true; }); this.bind('view:hide',function(){ self.visible = false; }); var stateData = _.extend({ geomField: null, lonField: null, latField: null, autoZoom: true }, options.state ); this.state = new recline.Model.ObjectState(stateData); this.menu = new my.MapMenu({ model: this.model, state: this.state.toJSON() }); this.menu.state.bind('change', function() { self.state.set(self.menu.state.toJSON()); self.redraw(); }); this.elSidebar = this.menu.el; this.mapReady = false; this.render(); this.redraw(); }, // ### Public: Adds the necessary elements to the page. // // Also sets up the editor fields and the map if necessary. render: function() { var self = this; htmls = Mustache.render(this.template, this.model.toTemplateJSON()); $(this.el).html(htmls); this.$map = this.el.find('.panel.map'); return this; }, // ### Public: Redraws the features on the map according to the action provided // // Actions can be: // // * reset: Clear all features // * add: Add one or n features (records) // * remove: Remove one or n features (records) // * refresh: Clear existing features and add all current records redraw: function(action, doc){ var self = this; action = action || 'refresh'; // try to set things up if not already if (!self._geomReady()){ self._setupGeometryField(); } if (!self.mapReady){ self._setupMap(); } if (this._geomReady() && this.mapReady){ if (action == 'reset' || action == 'refresh'){ this.features.clearLayers(); this._add(this.model.records.models); } else if (action == 'add' && doc){ this._add(doc); } else if (action == 'remove' && doc){ this._remove(doc); } if (this.state.get('autoZoom')){ if (this.visible){ this._zoomToFeatures(); } else { this._zoomPending = true; } } } }, _geomReady: function() { return Boolean(this.state.get('geomField') || (this.state.get('latField') && this.state.get('lonField'))); }, // Private: Add one or n features to the map // // For each record passed, a GeoJSON geometry will be extracted and added // to the features layer. If an exception is thrown, the process will be // stopped and an error notification shown. // // Each feature will have a popup associated with all the record fields. // _add: function(docs){ var self = this; if (!(docs instanceof Array)) docs = [docs]; var count = 0; var wrongSoFar = 0; _.every(docs,function(doc){ count += 1; var feature = self._getGeometryFromRecord(doc); if (typeof feature === 'undefined' || feature === null){ // Empty field return true; } else if (feature instanceof Object){ // Build popup contents // TODO: mustache? html = '' for (key in doc.attributes){ if (!(self.state.get('geomField') && key == self.state.get('geomField'))){ html += '
' + key + ': '+ doc.attributes[key] + '
'; } } feature.properties = {popupContent: html}; // Add a reference to the model id, which will allow us to // link this Leaflet layer to a Recline doc feature.properties.cid = doc.cid; try { self.features.addGeoJSON(feature); } catch (except) { wrongSoFar += 1; var msg = 'Wrong geometry value'; if (except.message) msg += ' (' + except.message + ')'; if (wrongSoFar <= 10) { self.trigger('recline:flash', {message: msg, category:'error'}); } } } else { wrongSoFar += 1 if (wrongSoFar <= 10) { self.trigger('recline:flash', {message: 'Wrong geometry value', category:'error'}); } } return true; }); }, // Private: Remove one or n features to the map // _remove: function(docs){ var self = this; if (!(docs instanceof Array)) docs = [docs]; _.each(docs,function(doc){ for (key in self.features._layers){ if (self.features._layers[key].cid == doc.cid){ self.features.removeLayer(self.features._layers[key]); } } }); }, // Private: Return a GeoJSON geomtry extracted from the record fields // _getGeometryFromRecord: function(doc){ if (this.state.get('geomField')){ var value = doc.get(this.state.get('geomField')); if (typeof(value) === 'string'){ // We *may* have a GeoJSON string representation try { value = $.parseJSON(value); } catch(e) {} } if (typeof(value) === 'string') { value = value.replace('(', '').replace(')', ''); var parts = value.split(','); var lat = parseFloat(parts[0]); var lon = parseFloat(parts[1]); if (!isNaN(lon) && !isNaN(parseFloat(lat))) { return { "type": "Point", "coordinates": [lon, lat] }; } else { return null; } } else if (value && value.slice) { // [ lon, lat ] return { "type": "Point", "coordinates": [value[0], value[1]] }; } else if (value && value.lat) { // of form { lat: ..., lon: ...} return { "type": "Point", "coordinates": [value.lon || value.lng, value.lat] }; } // We o/w assume that contents of the field are a valid GeoJSON object return value; } else if (this.state.get('lonField') && this.state.get('latField')){ // We'll create a GeoJSON like point object from the two lat/lon fields var lon = doc.get(this.state.get('lonField')); var lat = doc.get(this.state.get('latField')); if (!isNaN(parseFloat(lon)) && !isNaN(parseFloat(lat))) { return { type: 'Point', coordinates: [lon,lat] }; } } return null; }, // Private: Check if there is a field with GeoJSON geometries or alternatively, // two fields with lat/lon values. // // If not found, the user can define them via the UI form. _setupGeometryField: function(){ // should not overwrite if we have already set this (e.g. explicitly via state) if (!this._geomReady()) { this.state.set({ geomField: this._checkField(this.geometryFieldNames), latField: this._checkField(this.latitudeFieldNames), lonField: this._checkField(this.longitudeFieldNames) }); this.menu.state.set(this.state.toJSON()); } }, // Private: Check if a field in the current model exists in the provided // list of names. // // _checkField: function(fieldNames){ var field; var modelFieldNames = this.model.fields.pluck('id'); for (var i = 0; i < fieldNames.length; i++){ for (var j = 0; j < modelFieldNames.length; j++){ if (modelFieldNames[j].toLowerCase() == fieldNames[i].toLowerCase()) return modelFieldNames[j]; } } return null; }, // Private: Zoom to map to current features extent if any, or to the full // extent if none. // _zoomToFeatures: function(){ var bounds = this.features.getBounds(); if (bounds){ this.map.fitBounds(bounds); } else { this.map.setView(new L.LatLng(0, 0), 2); } }, // Private: Sets up the Leaflet map control and the features layer. // // The map uses a base layer from [MapQuest](http://www.mapquest.com) based // on [OpenStreetMap](http://openstreetmap.org). // _setupMap: function(){ this.map = new L.Map(this.$map.get(0)); var mapUrl = "http://otile{s}.mqcdn.com/tiles/1.0.0/osm/{z}/{x}/{y}.png"; var osmAttribution = 'Map data © 2011 OpenStreetMap contributors, Tiles Courtesy of MapQuest '; var bg = new L.TileLayer(mapUrl, {maxZoom: 18, attribution: osmAttribution ,subdomains: '1234'}); this.map.addLayer(bg); this.features = new L.GeoJSON(); this.features.on('featureparse', function (e) { if (e.properties && e.properties.popupContent){ e.layer.bindPopup(e.properties.popupContent); } if (e.properties && e.properties.cid){ e.layer.cid = e.properties.cid; } }); // This will be available in the next Leaflet stable release. // In the meantime we add it manually to our layer. this.features.getBounds = function(){ var bounds = new L.LatLngBounds(); this._iterateLayers(function (layer) { if (layer instanceof L.Marker){ bounds.extend(layer.getLatLng()); } else { if (layer.getBounds){ bounds.extend(layer.getBounds().getNorthEast()); bounds.extend(layer.getBounds().getSouthWest()); } } }, this); return (typeof bounds.getNorthEast() !== 'undefined') ? bounds : null; } this.map.addLayer(this.features); this.map.setView(new L.LatLng(0, 0), 2); this.mapReady = true; }, // Private: Helper function to select an option from a select list // _selectOption: function(id,value){ var options = $('.' + id + ' > select > option'); if (options){ options.each(function(opt){ if (this.value == value) { $(this).attr('selected','selected'); return false; } }); } } }); my.MapMenu = Backbone.View.extend({ className: 'editor', template: ' \
\
\
\ \ \
\
\ \
\ \
\ \
\ \
\
\ \
\
\ \
\
\ \
\ \ \
\ ', // Define here events for UI elements events: { 'click .editor-update-map': 'onEditorSubmit', 'change .editor-field-type': 'onFieldTypeChange', 'click #editor-auto-zoom': 'onAutoZoomChange' }, initialize: function(options) { var self = this; this.el = $(this.el); _.bindAll(this, 'render'); this.model.fields.bind('change', this.render); this.state = new recline.Model.ObjectState(options.state); this.state.bind('change', this.render); this.render(); }, // ### Public: Adds the necessary elements to the page. // // Also sets up the editor fields and the map if necessary. render: function() { var self = this; htmls = Mustache.render(this.template, this.model.toTemplateJSON()); $(this.el).html(htmls); if (this._geomReady() && this.model.fields.length){ if (this.state.get('geomField')){ this._selectOption('editor-geom-field',this.state.get('geomField')); this.el.find('#editor-field-type-geom').attr('checked','checked').change(); } else{ this._selectOption('editor-lon-field',this.state.get('lonField')); this._selectOption('editor-lat-field',this.state.get('latField')); this.el.find('#editor-field-type-latlon').attr('checked','checked').change(); } } if (this.state.get('autoZoom')) { this.el.find('#editor-auto-zoom').attr('checked', 'checked'); } else { this.el.find('#editor-auto-zoom').removeAttr('checked'); } return this; }, _geomReady: function() { return Boolean(this.state.get('geomField') || (this.state.get('latField') && this.state.get('lonField'))); }, // ## UI Event handlers // // Public: Update map with user options // // Right now the only configurable option is what field(s) contains the // location information. // onEditorSubmit: function(e){ e.preventDefault(); if (this.el.find('#editor-field-type-geom').attr('checked')){ this.state.set({ geomField: this.el.find('.editor-geom-field > select > option:selected').val(), lonField: null, latField: null }); } else { this.state.set({ geomField: null, lonField: this.el.find('.editor-lon-field > select > option:selected').val(), latField: this.el.find('.editor-lat-field > select > option:selected').val() }); } return false; }, // Public: Shows the relevant select lists depending on the location field // type selected. // onFieldTypeChange: function(e){ if (e.target.value == 'geom'){ this.el.find('.editor-field-type-geom').show(); this.el.find('.editor-field-type-latlon').hide(); } else { this.el.find('.editor-field-type-geom').hide(); this.el.find('.editor-field-type-latlon').show(); } }, onAutoZoomChange: function(e){ this.state.set({autoZoom: !this.state.get('autoZoom')}); }, // Private: Helper function to select an option from a select list // _selectOption: function(id,value){ var options = this.el.find('.' + id + ' > select > option'); if (options){ options.each(function(opt){ if (this.value == value) { $(this).attr('selected','selected'); return false; } }); } } }); })(jQuery, recline.View); /*jshint multistr:true */ // Standard JS module setup this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## MultiView // // Manage multiple views together along with query editor etc. Usage: // //
// var myExplorer = new model.recline.MultiView({
//   model: {{recline.Model.Dataset instance}}
//   el: {{an existing dom element}}
//   views: {{dataset views}}
//   state: {{state configuration -- see below}}
// });
// 
// // ### Parameters // // **model**: (required) recline.model.Dataset instance. // // **el**: (required) DOM element to bind to. NB: the element already // being in the DOM is important for rendering of some subviews (e.g. // Graph). // // **views**: (optional) the dataset views (Grid, Graph etc) for // MultiView to show. This is an array of view hashes. If not provided // initialize with (recline.View.)Grid, Graph, and Map views (with obvious id // and labels!). // //
// var views = [
//   {
//     id: 'grid', // used for routing
//     label: 'Grid', // used for view switcher
//     view: new recline.View.Grid({
//       model: dataset
//     })
//   },
//   {
//     id: 'graph',
//     label: 'Graph',
//     view: new recline.View.Graph({
//       model: dataset
//     })
//   }
// ];
// 
// // **state**: standard state config for this view. This state is slightly // special as it includes config of many of the subviews. // //
// state = {
//     query: {dataset query state - see dataset.queryState object}
//     view-{id1}: {view-state for this view}
//     view-{id2}: {view-state for }
//     ...
//     // Explorer
//     currentView: id of current view (defaults to first view if not specified)
//     readOnly: (default: false) run in read-only mode
// }
// 
// // Note that at present we do *not* serialize information about the actual set // of views in use -- e.g. those specified by the views argument -- but instead // expect either that the default views are fine or that the client to have // initialized the MultiView with the relevant views themselves. my.MultiView = Backbone.View.extend({ template: ' \
\
\ \
\ \
\ {{recordCount}} records\
\ \
\
\
\
\
\
\ ', events: { 'click .menu-right a': '_onMenuClick', 'click .navigation a': '_onSwitchView' }, initialize: function(options) { var self = this; this.el = $(this.el); this._setupState(options.state); // Hash of 'page' views (i.e. those for whole page) keyed by page name if (options.views) { this.pageViews = options.views; } else { this.pageViews = [{ id: 'grid', label: 'Grid', view: new my.SlickGrid({ model: this.model, state: this.state.get('view-grid') }), }, { id: 'graph', label: 'Graph', view: new my.Graph({ model: this.model, state: this.state.get('view-graph') }), }, { id: 'map', label: 'Map', view: new my.Map({ model: this.model, state: this.state.get('view-map') }), }, { id: 'timeline', label: 'Timeline', view: new my.Timeline({ model: this.model, state: this.state.get('view-timeline') }), }, { id: 'transform', label: 'Transform', view: new my.Transform({ model: this.model }) }]; } // these must be called after pageViews are created this.render(); this._bindStateChanges(); this._bindFlashNotifications(); // now do updates based on state (need to come after render) if (this.state.get('readOnly')) { this.setReadOnly(); } if (this.state.get('currentView')) { this.updateNav(this.state.get('currentView')); } else { this.updateNav(this.pageViews[0].id); } this.model.bind('query:start', function() { self.notify({loader: true, persist: true}); }); this.model.bind('query:done', function() { self.clearNotifications(); self.el.find('.doc-count').text(self.model.recordCount || 'Unknown'); }); this.model.bind('query:fail', function(error) { self.clearNotifications(); var msg = ''; if (typeof(error) == 'string') { msg = error; } else if (typeof(error) == 'object') { if (error.title) { msg = error.title + ': '; } if (error.message) { msg += error.message; } } else { msg = 'There was an error querying the backend'; } self.notify({message: msg, category: 'error', persist: true}); }); // retrieve basic data like fields etc // note this.model and dataset returned are the same // TODO: set query state ...? this.model.queryState.set(self.state.get('query'), {silent: true}); this.model.fetch() .fail(function(error) { self.notify({message: error.message, category: 'error', persist: true}); }); }, setReadOnly: function() { this.el.addClass('recline-read-only'); }, render: function() { var tmplData = this.model.toTemplateJSON(); tmplData.views = this.pageViews; var template = Mustache.render(this.template, tmplData); $(this.el).html(template); // now create and append other views var $dataViewContainer = this.el.find('.data-view-container'); var $dataSidebar = this.el.find('.data-view-sidebar'); // the main views _.each(this.pageViews, function(view, pageName) { $dataViewContainer.append(view.view.el); if (view.view.elSidebar) { $dataSidebar.append(view.view.elSidebar); } }); var pager = new recline.View.Pager({ model: this.model.queryState }); this.el.find('.recline-results-info').after(pager.el); var queryEditor = new recline.View.QueryEditor({ model: this.model.queryState }); this.el.find('.query-editor-here').append(queryEditor.el); var filterEditor = new recline.View.FilterEditor({ model: this.model }); this.$filterEditor = filterEditor.el; $dataSidebar.append(filterEditor.el); var fieldsView = new recline.View.Fields({ model: this.model }); this.$fieldsView = fieldsView.el; $dataSidebar.append(fieldsView.el); }, updateNav: function(pageName) { this.el.find('.navigation a').removeClass('active'); var $el = this.el.find('.navigation a[data-view="' + pageName + '"]'); $el.addClass('active'); // show the specific page _.each(this.pageViews, function(view, idx) { if (view.id === pageName) { view.view.el.show(); if (view.view.elSidebar) { view.view.elSidebar.show(); } view.view.trigger('view:show'); } else { view.view.el.hide(); if (view.view.elSidebar) { view.view.elSidebar.hide(); } view.view.trigger('view:hide'); } }); }, _onMenuClick: function(e) { e.preventDefault(); var action = $(e.target).attr('data-action'); if (action === 'filters') { this.$filterEditor.toggle(); } else if (action === 'fields') { this.$fieldsView.toggle(); } else if (action === 'transform') { this.transformView.el.toggle(); } }, _onSwitchView: function(e) { e.preventDefault(); var viewName = $(e.target).attr('data-view'); this.updateNav(viewName); this.state.set({currentView: viewName}); }, // create a state object for this view and do the job of // // a) initializing it from both data passed in and other sources (e.g. hash url) // // b) ensure the state object is updated in responese to changes in subviews, query etc. _setupState: function(initialState) { var self = this; // get data from the query string / hash url plus some defaults var qs = my.parseHashQueryString(); var query = qs.reclineQuery; query = query ? JSON.parse(query) : self.model.queryState.toJSON(); // backwards compatability (now named view-graph but was named graph) var graphState = qs['view-graph'] || qs.graph; graphState = graphState ? JSON.parse(graphState) : {}; // now get default data + hash url plus initial state and initial our state object with it var stateData = _.extend({ query: query, 'view-graph': graphState, backend: this.model.backend.__type__, url: this.model.get('url'), currentView: null, readOnly: false }, initialState); this.state = new recline.Model.ObjectState(stateData); }, _bindStateChanges: function() { var self = this; // finally ensure we update our state object when state of sub-object changes so that state is always up to date this.model.queryState.bind('change', function() { self.state.set({query: self.model.queryState.toJSON()}); }); _.each(this.pageViews, function(pageView) { if (pageView.view.state && pageView.view.state.bind) { var update = {}; update['view-' + pageView.id] = pageView.view.state.toJSON(); self.state.set(update); pageView.view.state.bind('change', function() { var update = {}; update['view-' + pageView.id] = pageView.view.state.toJSON(); // had problems where change not being triggered for e.g. grid view so let's do it explicitly self.state.set(update, {silent: true}); self.state.trigger('change'); }); } }); }, _bindFlashNotifications: function() { var self = this; _.each(this.pageViews, function(pageView) { pageView.view.bind('recline:flash', function(flash) { self.notify(flash); }); }); }, // ### notify // // Create a notification (a div.alert in div.alert-messsages) using provided // flash object. Flash attributes (all are optional): // // * message: message to show. // * category: warning (default), success, error // * persist: if true alert is persistent, o/w hidden after 3s (default = false) // * loader: if true show loading spinner notify: function(flash) { var tmplData = _.extend({ message: 'Loading', category: 'warning', loader: false }, flash ); if (tmplData.loader) { var _template = ' \
\ {{message}} \   \
'; } else { var _template = ' \
× \ {{message}} \
'; } var _templated = $(Mustache.render(_template, tmplData)); _templated = $(_templated).appendTo($('.recline-data-explorer .alert-messages')); if (!flash.persist) { setTimeout(function() { $(_templated).fadeOut(1000, function() { $(this).remove(); }); }, 1000); } }, // ### clearNotifications // // Clear all existing notifications clearNotifications: function() { var $notifications = $('.recline-data-explorer .alert-messages .alert'); $notifications.fadeOut(1500, function() { $(this).remove(); }); } }); // ### MultiView.restore // // Restore a MultiView instance from a serialized state including the associated dataset my.MultiView.restore = function(state) { var dataset = recline.Model.Dataset.restore(state); var explorer = new my.MultiView({ model: dataset, state: state }); return explorer; } // ## Miscellaneous Utilities var urlPathRegex = /^([^?]+)(\?.*)?/; // Parse the Hash section of a URL into path and query string my.parseHashUrl = function(hashUrl) { var parsed = urlPathRegex.exec(hashUrl); if (parsed === null) { return {}; } else { return { path: parsed[1], query: parsed[2] || '' }; } }; // Parse a URL query string (?xyz=abc...) into a dictionary. my.parseQueryString = function(q) { if (!q) { return {}; } var urlParams = {}, e, d = function (s) { return unescape(s.replace(/\+/g, " ")); }, r = /([^&=]+)=?([^&]*)/g; if (q && q.length && q[0] === '?') { q = q.slice(1); } while (e = r.exec(q)) { // TODO: have values be array as query string allow repetition of keys urlParams[d(e[1])] = d(e[2]); } return urlParams; }; // Parse the query string out of the URL hash my.parseHashQueryString = function() { q = my.parseHashUrl(window.location.hash).query; return my.parseQueryString(q); }; // Compse a Query String my.composeQueryString = function(queryParams) { var queryString = '?'; var items = []; $.each(queryParams, function(key, value) { if (typeof(value) === 'object') { value = JSON.stringify(value); } items.push(key + '=' + encodeURIComponent(value)); }); queryString += items.join('&'); return queryString; }; my.getNewHashForQueryString = function(queryParams) { var queryPart = my.composeQueryString(queryParams); if (window.location.hash) { // slice(1) to remove # at start return window.location.hash.split('?')[0].slice(1) + queryPart; } else { return queryPart; } }; my.setHashQueryString = function(queryParams) { window.location.hash = my.getNewHashForQueryString(queryParams); }; })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## SlickGrid Dataset View // // Provides a tabular view on a Dataset, based on SlickGrid. // // https://github.com/mleibman/SlickGrid // // Initialize it with a `recline.Model.Dataset`. // // NB: you need an explicit height on the element for slickgrid to work my.SlickGrid = Backbone.View.extend({ tagName: "div", className: "recline-slickgrid", initialize: function(modelEtc) { var self = this; this.el = $(this.el); this.el.addClass('recline-slickgrid'); _.bindAll(this, 'render'); this.model.records.bind('add', this.render); this.model.records.bind('reset', this.render); this.model.records.bind('remove', this.render); var state = _.extend({ hiddenColumns: [], columnsOrder: [], columnsSort: {}, columnsWidth: [], fitColumns: false }, modelEtc.state ); this.state = new recline.Model.ObjectState(state); this.bind('view:show',function(){ // If the div is hidden, SlickGrid will calculate wrongly some // sizes so we must render it explicitly when the view is visible if (!self.rendered){ if (!self.grid){ self.render(); } self.grid.init(); self.rendered = true; } self.visible = true; }); this.bind('view:hide',function(){ self.visible = false; }); }, events: { }, render: function() { var self = this; var options = { enableCellNavigation: true, enableColumnReorder: true, explicitInitialization: true, syncColumnCellResize: true, forceFitColumns: this.state.get('fitColumns') }; // We need all columns, even the hidden ones, to show on the column picker var columns = []; // custom formatter as default one escapes html // plus this way we distinguish between rendering/formatting and computed value (so e.g. sort still works ...) // row = row index, cell = cell index, value = value, columnDef = column definition, dataContext = full row values var formatter = function(row, cell, value, columnDef, dataContext) { var field = self.model.fields.get(columnDef.id); if (field.renderer) { return field.renderer(value, field, dataContext); } else { return value; } } _.each(this.model.fields.toJSON(),function(field){ var column = { id:field['id'], name:field['label'], field:field['id'], sortable: true, minWidth: 80, formatter: formatter }; var widthInfo = _.find(self.state.get('columnsWidth'),function(c){return c.column == field.id}); if (widthInfo){ column['width'] = widthInfo.width; } columns.push(column); }); // Restrict the visible columns var visibleColumns = columns.filter(function(column) { return _.indexOf(self.state.get('hiddenColumns'), column.id) == -1; }); // Order them if there is ordering info on the state if (this.state.get('columnsOrder')){ visibleColumns = visibleColumns.sort(function(a,b){ return _.indexOf(self.state.get('columnsOrder'),a.id) > _.indexOf(self.state.get('columnsOrder'),b.id) ? 1 : -1; }); columns = columns.sort(function(a,b){ return _.indexOf(self.state.get('columnsOrder'),a.id) > _.indexOf(self.state.get('columnsOrder'),b.id) ? 1 : -1; }); } // Move hidden columns to the end, so they appear at the bottom of the // column picker var tempHiddenColumns = []; for (var i = columns.length -1; i >= 0; i--){ if (_.indexOf(_.pluck(visibleColumns,'id'),columns[i].id) == -1){ tempHiddenColumns.push(columns.splice(i,1)[0]); } } columns = columns.concat(tempHiddenColumns); var data = []; this.model.records.each(function(doc){ var row = {}; self.model.fields.each(function(field){ row[field.id] = doc.getFieldValueUnrendered(field); }); data.push(row); }); this.grid = new Slick.Grid(this.el, data, visibleColumns, options); // Column sorting var sortInfo = this.model.queryState.get('sort'); if (sortInfo){ var column = _.keys(sortInfo[0])[0]; var sortAsc = !(sortInfo[0][column].order == 'desc'); this.grid.setSortColumn(column, sortAsc); } this.grid.onSort.subscribe(function(e, args){ var order = (args.sortAsc) ? 'asc':'desc'; var sort = [{}]; sort[0][args.sortCol.field] = {order: order}; self.model.query({sort: sort}); }); this.grid.onColumnsReordered.subscribe(function(e, args){ self.state.set({columnsOrder: _.pluck(self.grid.getColumns(),'id')}); }); this.grid.onColumnsResized.subscribe(function(e, args){ var columns = args.grid.getColumns(); var defaultColumnWidth = args.grid.getOptions().defaultColumnWidth; var columnsWidth = []; _.each(columns,function(column){ if (column.width != defaultColumnWidth){ columnsWidth.push({column:column.id,width:column.width}); } }); self.state.set({columnsWidth:columnsWidth}); }); var columnpicker = new Slick.Controls.ColumnPicker(columns, this.grid, _.extend(options,{state:this.state})); if (self.visible){ self.grid.init(); self.rendered = true; } else { // Defer rendering until the view is visible self.rendered = false; } return this; } }); })(jQuery, recline.View); /* * Context menu for the column picker, adapted from * http://mleibman.github.com/SlickGrid/examples/example-grouping * */ (function ($) { function SlickColumnPicker(columns, grid, options) { var $menu; var columnCheckboxes; var defaults = { fadeSpeed:250 }; function init() { grid.onHeaderContextMenu.subscribe(handleHeaderContextMenu); options = $.extend({}, defaults, options); $menu = $('