25 |
--------------------------------------------------------------------------------
/CHANGELOG:
--------------------------------------------------------------------------------
1 | 2021-05-25 Release 0.6
2 | - add support for object-style JSON
3 | - remove Source.getMatchingColumns()
4 | - add Source.getColumnIndex() and Source.getColumnIndices()
5 | - many speed optimisations
6 |
7 | 2021-05-07 Release 0.5
8 | - updated to eliminate complaints from ESLint
9 | - added getRawValues() method to get all the values in a dataset column (not just unique)
10 |
11 | 2021-04-27 Release 0.4.1
12 | - bug fix for reverse in sort filter
13 |
14 | 2021-04-27 Release 0.4
15 | - added standalone hxl-parse-hashtag.js module for visualisations, etc
16 | - added SortFilter and PreviewFilter, and corresponding hxl.Source.sort() and hxl.Source.preview() methods
17 | - added hxl.Source.sum() aggregation method
18 |
19 | 2019-03-29 Release 0.3
20 | - added hxl.Source.exportArray() to export data as an array
21 | including hashtags (and optionally, headers)
22 | - fix bug with null columns when there's no hashtag
23 | - start adding data typing methods
24 | - add support for wildcard tag patterns (e.g. "#*+f")
25 | - add support for absolute tag patterns (e.g. "#affected+children")
26 | - make hashtag specs and tag patterns case insensitive
27 | - added matchList() method to TagPattern class
28 | - add hxl.match() and hxl.matchList() convenience functions for
29 | matching tag patterns
30 |
--------------------------------------------------------------------------------
/test/test-column.js:
--------------------------------------------------------------------------------
1 | /**
2 | * hxl.classes.Column tests
3 | */
4 |
5 | QUnit.module("hxl.classes.Column", {
6 | setup: function () {
7 | this.column = hxl.classes.Column.parse("#adm1+code+pcode", "Region");
8 | }
9 | });
10 |
11 | QUnit.test("column created", function(assert) {
12 | assert.ok(this.column);
13 | });
14 |
15 | QUnit.test("header ok", function(assert) {
16 | assert.equal(this.column.header, "Region");
17 | });
18 |
19 | QUnit.test("tag parsed", function(assert) {
20 | assert.equal(this.column.tag, "#adm1");
21 | });
22 |
23 | QUnit.test("attributes ok", function(assert) {
24 | assert.equal(this.column.attributes.length, 2);
25 | assert.ok(this.column.attributes.indexOf("code") > -1);
26 | assert.ok(this.column.attributes.indexOf("pcode") > -1);
27 | });
28 |
29 | QUnit.test("display tag", function(assert) {
30 | assert.equal(this.column.displayTag, "#adm1+code+pcode");
31 | });
32 |
33 | QUnit.test("bad tag", function(assert) {
34 | // no exception
35 | assert.ok(hxl.classes.Column.parse("#0abc"));
36 | // exception
37 | var seen_exception = false;
38 | try {
39 | hxl.classes.Column.parse("#0abc", null, true);
40 | } catch (e) {
41 | seen_exception = true;
42 | }
43 | assert.ok(seen_exception);
44 | });
45 |
46 |
47 | // end
48 |
--------------------------------------------------------------------------------
/test/test-row.js:
--------------------------------------------------------------------------------
1 | /**
2 | * hxl.classes.Row tests
3 | */
4 |
5 | QUnit.module("hxl.classes.Row", {
6 | setup: function () {
7 | this.columns = ["#org+funder", "#org+impl", "#adm1+code"];
8 | this.values = ["Donor", "NGO", "Region"];
9 | this.dataset = new hxl.classes.Dataset([this.columns, this.values]);
10 | this.row = new hxl.classes.Row(this.values, this.dataset.columns, this.dataset);
11 | }
12 | });
13 |
14 | QUnit.test("row created", function(assert) {
15 | assert.ok(this.row);
16 | });
17 |
18 | QUnit.test("values", function(assert) {
19 | assert.deepEqual(this.row.values, this.values);
20 | });
21 |
22 | QUnit.test("columns", function(assert) {
23 | assert.deepEqual(this.row.columns.map(function(col) { return col.displayTag; }), this.columns);
24 | });
25 |
26 | QUnit.test("get one value", function(assert) {
27 | assert.equal(this.row.get("#org"), "Donor");
28 | assert.equal(this.row.get("#org+funder"), "Donor");
29 | assert.equal(this.row.get("#org-funder"), "NGO");
30 | assert.equal(this.row.get("#org+impl"), "NGO");
31 | assert.equal(this.row.get("#org-impl"), "Donor");
32 | });
33 |
34 | QUnit.test("get all values", function(assert) {
35 | assert.deepEqual(this.row.getAll("#org"), ["Donor", "NGO"]);
36 | assert.deepEqual(this.row.getAll("#org+impl"), ["NGO"]);
37 | assert.deepEqual(this.row.getAll("#org-impl"), ["Donor"]);
38 | });
39 |
40 | // end
41 |
--------------------------------------------------------------------------------
/test/test-static.js:
--------------------------------------------------------------------------------
1 | /**
2 | * static methods tests
3 | */
4 |
5 | QUnit.module("hxl", {});
6 |
7 | QUnit.test("normalise whitespace", function(assert) {
8 | assert.equal("xx YY", hxl.normaliseSpace(" xx\n YY\t"));
9 | });
10 |
11 | QUnit.test("normalise string", function(assert) {
12 | assert.equal("xx yy", hxl.normaliseString(" xx\n YY\t"));
13 | });
14 |
15 | QUnit.test("normalise year", function(assert) {
16 | assert.equal('2017', hxl.normaliseDate('2017'));
17 | });
18 |
19 | QUnit.test("normalise year-month", function(assert) {
20 | assert.equal('2017-01', hxl.normaliseDate('2017-01'));
21 | });
22 |
23 | QUnit.test("normalise quarter", function(assert) {
24 | assert.equal('2017Q1', hxl.normaliseDate('2017Q1'));
25 | });
26 |
27 | QUnit.test("normalise mm-dd date", function(assert) {
28 | assert.equal('2017-01-13', hxl.normaliseDate('1/13/17'));
29 | });
30 |
31 | QUnit.test("normalise dd-mm date", function(assert) {
32 | assert.equal('2017-01-13', hxl.normaliseDate('13/1/17'));
33 | });
34 |
35 | QUnit.test("force dd-mm date", function(assert) {
36 | assert.equal('2017-01-02', hxl.normaliseDate('2/1/17', true));
37 | });
38 |
39 | QUnit.test("force mm-dd date", function(assert) {
40 | assert.equal('2017-02-01', hxl.normaliseDate('2/1/17', false));
41 | });
42 |
43 | QUnit.test("month name", function(assert) {
44 | assert.equal('2017-01-02', hxl.normaliseDate('2 Jan/17'));
45 | });
46 |
47 | // end
48 |
--------------------------------------------------------------------------------
/hxl-parse-hashtag.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Stand-alone function to parse a HXL hashtag and attributes
3 | *
4 | * The result will be an object with two properties, "tag" for the
5 | * hashtag, and "atts" for an array of attributes. For example,
6 | * #affected+refugees+children+f will parse to
7 | *
8 | * {
9 | * tag: "affected",
10 | * atts: ["refugees", "children", "f"]
11 | * }
12 | *
13 | * Note that the parser removes "#" from the hashtag, and "+" from the
14 | * attribute names. It also normalised all names to lower case.
15 | *
16 | * To check for an attribute:
17 | *
18 | * p = hxl_parse_hashtag("#affected +refugees +children +f");
19 | * p.atts.includes("refugees"); // true
20 | * p.atts.includes("idps"); // false
21 | *
22 | * @param s The hashtag and attributes (may contain whitespace)
23 | * @returns The parsed object, or False if the hashtag spec was
24 | * unparseable.
25 | */
26 | function hxl_parse_hashtag (s) {
27 |
28 | var parsed = s.match(/^\s*(#[A-Za-z][A-Za-z0-9_]*)((\s*\+[A-Za-z][A-Za-z0-9_]*)*)?\s*$/);
29 |
30 | if (parsed) {
31 | var attributes = [];
32 | if (parsed[2]) {
33 | attributes = parsed[2].split(/\s*\+/).filter(attribute => attribute.toLowerCase());
34 | }
35 | return {
36 | tag: parsed[1].toLowerCase().substring(1),
37 | atts: attributes
38 | };
39 |
40 | } else {
41 | return False;
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/test/test-tagpattern.js:
--------------------------------------------------------------------------------
1 | /**
2 | * hxl.classes.TagPattern tests
3 | */
4 |
5 | QUnit.module("hxl.classes.TagPattern", {
6 | setup: function () {
7 | this.pattern = hxl.classes.TagPattern.parse("#adm1+code-iso");
8 | this.column = hxl.classes.Column.parse("#adm1+code+pcode", "Region");
9 | }
10 | });
11 |
12 | QUnit.test("pattern created", function(assert) {
13 | assert.ok(this.pattern);
14 | });
15 |
16 | QUnit.test("tag ok", function(assert) {
17 | assert.equal(this.pattern.tag, "#adm1");
18 | });
19 |
20 | QUnit.test("include ok", function(assert) {
21 | assert.deepEqual(this.pattern.includeAttributes, ['code']);
22 | });
23 |
24 | QUnit.test("exclude ok", function(assert) {
25 | assert.deepEqual(this.pattern.excludeAttributes, ['iso']);
26 | });
27 |
28 | QUnit.test("positive match", function(assert) {
29 | assert.ok(this.pattern.match(this.column));
30 | });
31 |
32 | QUnit.test("embedded whitespace", function(assert) {
33 | assert.ok(hxl.classes.TagPattern.parse('#adm1 +foo'));
34 | assert.ok(hxl.classes.TagPattern.parse(' #adm1+foo'));
35 | assert.ok(hxl.classes.TagPattern.parse(' #adm1+foo '));
36 | assert.ok(hxl.classes.TagPattern.parse(' #adm1+foo '));
37 | });
38 |
39 | QUnit.test("bad pattern", function(assert) {
40 | // no exception
41 | assert.ok(hxl.classes.TagPattern.parse("#abc+x=y") === null);
42 | // exception requested
43 | var seen_exception = false;
44 | try {
45 | hxl.classes.TagPattern.parse("#abc+x=y", true);
46 | } catch (e) {
47 | seen_exception = true;
48 | }
49 | assert.ok(seen_exception);
50 | });
51 |
52 | QUnit.test("absolute pattern", function(assert) {
53 | var pattern = hxl.classes.TagPattern.parse("#foo+x!");
54 | assert.ok(pattern);
55 | assert.ok(pattern.match("#foo+x"));
56 | assert.ok(!pattern.match("#foo+y+x"))
57 | });
58 |
59 | QUnit.test("wildcard pattern", function(assert) {
60 | var pattern = hxl.classes.TagPattern.parse("#*+x");
61 | assert.ok(pattern);
62 | assert.ok(pattern.match("#foo+x"));
63 | assert.ok(!pattern.match("#foo"));
64 | });
65 |
66 | QUnit.test("find in list", function(assert) {
67 | var pattern = hxl.classes.TagPattern.parse("#foo+x");
68 | assert.ok(pattern.matchList(["#xxx", "#foo+y+x", "#yyy"]));
69 | assert.ok(!pattern.matchList(["#xxx", "#foo+y", "#yyy"]));
70 | });
71 |
72 | // end
73 |
--------------------------------------------------------------------------------
/test/test-dataset.js:
--------------------------------------------------------------------------------
1 | /**
2 | * hxl.classes.Dataset tests
3 | */
4 |
5 | QUnit.module("hxl.classes.Dataset", {
6 | setup: function () {
7 | this.test_data = [
8 | ['Pointless header'],
9 | ['Organisation', 'Second organisation', 'Sector', 'Province', 'Number reached'],
10 | ['#org', '#org', '#sector+cluster', '#adm1', '#reached'],
11 | ['Org 1', 'Org 1b', 'WASH', 'Coastal Province', '200'],
12 | ['Org 2', '', 'Health', 'Mountain Province', '300'],
13 | ['Org 3', '', 'Protection', 'Coastal Province', '400']
14 | ];
15 | this.dataset = new hxl.wrap(this.test_data);
16 | }
17 | });
18 |
19 | QUnit.test("dataset created", function(assert) {
20 | assert.ok(this.dataset);
21 | });
22 |
23 | QUnit.test("object-style JSON", function(assert) {
24 | let data = [
25 | {'#org': 'Org 1', '#sector+cluster': 'WASH', '#adm1': 'Coastal Province', '#reached': '200'},
26 | {'#org': 'Org 2', '#adm1': 'Mountain Province', '#reached': '300'},
27 | {'#org': 'Org 3', '#reached': '400', '#sector+cluster': 'Protection', '#adm1': 'Coastal Province'}
28 | ];
29 | dataset = hxl.wrap(data);
30 | assert.deepEqual(dataset.displayTags, ['#org', '#sector+cluster', '#adm1', '#reached']);
31 | assert.deepEqual(dataset.rawData, [
32 | ["Org 1", "WASH", "Coastal Province", "200"],
33 | ["Org 2", "", "Mountain Province", "300"],
34 | ["Org 3", "Protection", "Coastal Province", "400"]
35 | ]);
36 | });
37 |
38 | QUnit.test("headers", function(assert) {
39 | assert.deepEqual(this.dataset.headers, this.test_data[1]);
40 | });
41 |
42 | QUnit.test("tags", function(assert) {
43 | assert.notDeepEqual(this.dataset.tags, this.test_data[2]);
44 | assert.deepEqual(this.dataset.displayTags, this.test_data[2]);
45 | });
46 |
47 | QUnit.test("columns", function(assert) {
48 | assert.deepEqual(this.dataset.columns.map(function (col) { return col.header; }), this.test_data[1]);
49 | assert.deepEqual(this.dataset.columns.map(function (col) { return col.displayTag; }), this.test_data[2]);
50 | });
51 |
52 | QUnit.test("dataset export", function(assert) {
53 | assert.deepEqual(this.dataset.exportArray(), this.test_data.slice(1));
54 | assert.deepEqual(this.dataset.exportArray(false), this.test_data.slice(1));
55 | assert.deepEqual(this.dataset.exportArray(true), this.test_data.slice(2));
56 | });
57 |
58 | QUnit.test("partly-tagged dataset", function(assert) {
59 | // confirm no null columns when not tagged
60 | var dataset = hxl.wrap([
61 | ['header', 'header', 'header'],
62 | ['#tag', '', '#tag'],
63 | ['a', 'b', 'c'],
64 | ['d', 'e', 'f']
65 | ]);
66 | dataset.columns.forEach((column) => {
67 | assert.ok(column);
68 | });
69 | });
70 |
71 | QUnit.test("rows", function(assert) {
72 | assert.deepEqual(this.dataset.rows.map(function (row) { return row.values; }), this.test_data.slice(3));
73 | });
74 |
75 | QUnit.test("raw data", function(assert) {
76 | assert.deepEqual(this.test_data.slice(3), this.dataset.rawData);
77 | });
78 |
79 | QUnit.test("iterator", function(assert) {
80 | var iterator = this.dataset.iterator();
81 | var index = 3;
82 | var row = null;
83 | while (row = iterator.next()) {
84 | assert.deepEqual(row.values, this.test_data[index]);
85 | index++;
86 | }
87 | });
88 |
89 | QUnit.test("each", function(assert) {
90 | var test_data = this.test_data;
91 | assert.equal(this.dataset.each(function (row, dataset, rowNumber) {
92 | assert.deepEqual(row.values, test_data[rowNumber + 3]);
93 | }), 3);
94 | });
95 |
96 | QUnit.test("min", function(assert) {
97 | assert.equal(this.dataset.getMin('#reached'), 200);
98 | });
99 |
100 | QUnit.test("max", function(assert) {
101 | assert.equal(this.dataset.getMax('#reached'), 400);
102 | });
103 |
104 | QUnit.test("sum", function(assert) {
105 | assert.equal(this.dataset.getSum('#reached'), 900);
106 | });
107 |
108 | QUnit.test("unique values", function(assert) {
109 | assert.deepEqual(this.dataset.getValues('#adm1'), ['Coastal Province', 'Mountain Province']);
110 | });
111 |
112 | QUnit.test("raw values", function(assert) {
113 | assert.deepEqual(this.dataset.getRawValues('#adm1'), ['Coastal Province', 'Mountain Province', 'Coastal Province']);
114 | });
115 |
116 | QUnit.test("numbery", function(assert) {
117 | assert.ok(!this.dataset.isNumbery('#org'));
118 | assert.ok(this.dataset.isNumbery('#reached'));
119 | });
120 |
121 | // end
122 |
--------------------------------------------------------------------------------
/jsdoc/files.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 | JsDoc Reference - File Index
8 |
9 |
10 |
174 |
175 |
176 |
177 |
179 |
180 |
181 |
183 |
184 |
Classes
185 |
218 |
219 |
222 |
File Index
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
238 |
240 |
241 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
242 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Built-In Namespace _global_
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
243 |
244 |
245 |
246 |
247 |
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 |
263 |
264 |
265 |
266 |
267 |
268 |
273 |
274 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:52 GMT-0400 (EDT)
275 |
181 |
183 |
184 |
Classes
185 |
218 |
219 |
222 |
Class Index
223 |
224 |
225 |
229 |
230 |
231 |
235 |
236 |
237 |
241 |
242 |
243 |
247 |
248 |
249 |
253 |
254 |
255 |
259 |
260 |
261 |
265 |
266 |
267 |
271 |
272 |
273 |
277 |
278 |
279 |
283 |
284 |
285 |
289 |
290 |
291 |
295 |
296 |
297 |
301 |
302 |
303 |
307 |
308 |
309 |
313 |
314 |
315 |
316 |
318 |
319 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
320 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Namespace hxl.classes
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Namespace Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 |
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 | Namespace Detail
283 |
284 |
285 |
286 | hxl.classes
287 |
288 |
289 |
290 |
291 |
292 |
293 |
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
323 |
324 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:52 GMT-0400 (EDT)
325 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.CacheFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | HXL filter to save a copy of a transformed HXL dataset.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 | Class Detail
283 |
284 |
285 |
286 | hxl.classes.CacheFilter(source)
287 |
288 |
289 |
290 | HXL filter to save a copy of a transformed HXL dataset.
291 |
292 | This filter stops the chain, so that any future requests won't
293 | go back and repeat earlier transformations. You should use it
294 | when there are some expensive operations earlier in the chain
295 | that you don't want to repeat.
296 |
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 | - Parameters:
305 |
306 | -
307 | {hxl.classes.Source} source
308 |
309 |
310 | - the hxl.classes.Source
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
339 |
340 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
341 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.IndexFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | Add index attributes (+i0, +i1, etc.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 | Class Detail
283 |
284 |
285 |
286 | hxl.classes.IndexFilter(source, pattern)
287 |
288 |
289 |
290 | Add index attributes (+i0, +i1, etc.) to a repeated tag.
291 |
292 | This is useful for query-type processing, where it's not otherwise
293 | easy to work with order. Normally, it's better to use semantic
294 | attributes like #org+funder, #org+impl, etc., but in some cases,
295 | that's not available, so you can automatically number the tags
296 | as #org+i0, #org+i1, etc., from left to right.
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 | - Parameters:
306 |
307 | -
308 | {hxl.classes.Source} source
309 |
310 |
311 | - the hxl.classes.Source
312 |
313 | -
314 | {string} pattern
315 |
316 |
317 | - the tag pattern to replace (see hxl.classes.TagPattern).
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
346 |
347 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
348 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.BaseFilter
232 |
233 |
234 |
235 |
236 |
237 |
Extends
238 | hxl.classes.Source.
239 |
240 |
241 |
242 |
243 |
244 |
Defined in: hxl.js.
245 |
246 |
247 |
248 |
249 |
250 |
251 | Class Summary
252 |
253 |
254 | | Constructor Attributes |
255 | Constructor Name and Description |
256 |
257 |
258 |
259 |
260 | | |
261 |
262 |
265 | Abstract class for a HXL filter.
266 | |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 | - Fields borrowed from class hxl.classes.Source:
- columns, displayTags, headers, rows, tags
280 |
281 |
282 |
283 |
284 |
285 |
286 |
287 |
288 |
289 |
290 |
291 | - Methods borrowed from class hxl.classes.Source:
- cache, count, each, forEach, getColumns, getDisplayTags, getHeaders, getMatchingColumns, getMax, getMin, getRows, getTags, getValues, hasColumn, index, isNumbery, iterator, rename, withColumns, withoutColumns, withoutRows, withRows
292 |
293 |
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
302 | Class Detail
303 |
304 |
305 |
306 | hxl.classes.BaseFilter(source)
307 |
308 |
309 |
310 | Abstract class for a HXL filter.
311 |
312 | Provide basic scaffolding for creating a class that reads from
313 | a HXL source, transforms the data on the fly, then sends out a new
314 | stream of HXL data.
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 | - Parameters:
324 |
325 | -
326 | {hxl.classes.Source} source
327 |
328 |
329 | - Another HXL data source to read from.
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 |
353 |
358 |
359 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:52 GMT-0400 (EDT)
360 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.RenameFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | HXL filter to rename a column (new header and tag).
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Get the renamed columns.
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Return copies of the rows with the new columns.
302 | |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 | Class Detail
319 |
320 |
321 |
322 | hxl.classes.RenameFilter(source, pattern, newTag, newHeader, index)
323 |
324 |
325 |
326 | HXL filter to rename a column (new header and tag).
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 | - Parameters:
336 |
337 | -
338 | source
339 |
340 |
341 | - the hxl.classes.Source
342 |
343 | -
344 | pattern
345 |
346 |
347 | - the tag pattern to replace
348 |
349 | -
350 | newTag
351 |
352 |
353 | - the new HXL tag (with attributes)
354 |
355 | -
356 | newHeader
357 |
358 |
359 | - (optional) the new text header. If undefined or
360 | null or false, don't change the existing header.
361 |
362 | -
363 | index
364 |
365 |
366 | - the zero-based index of the match to replace. If
367 | undefined or null or false, replace *all* matches.
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 |
380 |
381 |
382 |
383 |
384 |
385 |
386 |
387 | Method Detail
388 |
389 |
390 |
391 |
392 |
393 |
394 | getColumns()
395 |
396 |
397 |
398 | Get the renamed columns.
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 |
415 |
416 |
417 |
418 |
419 | iterator()
420 |
421 |
422 |
423 | Return copies of the rows with the new columns.
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 |
433 |
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
451 |
452 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
453 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.ColumnFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | HXL filter class to remove columns from a dataset.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Override hxl.classes.BaseFilter.getColumns to return only the allowed columns.
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Override hxl.classes.BaseFilter.iterator to get data with some columns removed.
302 | |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 | Class Detail
319 |
320 |
321 |
322 | hxl.classes.ColumnFilter(source, patterns, invert)
323 |
324 |
325 |
326 | HXL filter class to remove columns from a dataset.
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 | - Parameters:
336 |
337 | -
338 | source
339 |
340 |
341 | - the HXL data source (may be another filter).
342 |
343 | -
344 | patterns
345 |
346 |
347 | - a list of HXL tag patterns to include (or exclude).
348 |
349 | -
350 | invert
351 |
352 |
353 | - if true, exclude matching columns rather than including them (blacklist).
354 |
355 |
356 |
357 |
358 |
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 | Method Detail
374 |
375 |
376 |
377 |
378 |
379 |
380 | getColumns()
381 |
382 |
383 |
384 | Override hxl.classes.BaseFilter.getColumns to return only the allowed columns.
385 |
386 | This method triggers lazy processing that also saves the indices for
387 | slicing the data itself.
388 |
389 |
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 | - Returns:
401 |
402 | - a list of hxl.classes.Column objects.
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 |
415 | iterator()
416 |
417 |
418 |
419 | Override hxl.classes.BaseFilter.iterator to get data with some columns removed.
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 | - Returns:
433 |
434 | - an iterator object to read the modified data rows.
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 |
454 |
455 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
456 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.RowFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | HXL filter class to select rows from a source.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 | Field Summary
276 |
277 |
278 | | Field Attributes |
279 | Field Name and Description |
280 |
281 |
282 |
283 |
284 |
285 | | <static> |
286 |
287 |
290 | Operator functions.
291 | |
292 |
293 |
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 | Method Summary
307 |
308 |
309 | | Method Attributes |
310 | Method Name and Description |
311 |
312 |
313 |
314 |
315 |
316 | | |
317 |
318 |
320 | Override HXLFIlter.iterator to return only select rows.
321 | |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 | Class Detail
338 |
339 |
340 |
341 | hxl.classes.RowFilter(source, predicates, invert)
342 |
343 |
344 |
345 | HXL filter class to select rows from a source.
346 |
347 | Usage:
348 |
349 | // select all rows where #adm1 is the Coastal Region
350 | // *or* the population is greater than 1,000
351 | var filter = new hxl.classes.RowFilter(source,
352 | { pattern: '#adm1', test: 'Coastal Region' },
353 | { pattern: '#people_num', test: function(v) { return v > 1000; } }
354 | ]);
355 |
356 | Predicates are always "OR"'d together. If you need
357 | a logical "AND", then chain another select filter.
358 |
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 | - Parameters:
367 |
368 | -
369 | source
370 |
371 |
372 | - the hxl.classes.Source
373 |
374 | -
375 | predicates
376 |
377 |
378 | - a list of predicates, each of
379 | has a "test" property (and optionally, a "pattern" property).
380 |
381 | -
382 | invert
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 | Field Detail
403 |
404 |
405 |
406 |
<static>
407 |
408 |
409 | hxl.classes.RowFilter.OPERATORS
410 |
411 |
412 |
413 | Operator functions.
414 |
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 | Method Detail
433 |
434 |
435 |
436 |
437 |
438 |
439 | iterator()
440 |
441 |
442 |
443 | Override HXLFIlter.iterator to return only select rows.
444 |
445 |
446 |
447 |
448 |
449 |
450 |
451 |
452 |
453 |
454 |
455 |
456 | - Returns:
457 |
458 | - an iterator object that will skip rows that fail to pass at
459 | least one of the predicates.
460 |
461 |
462 |
463 |
464 |
465 |
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 |
474 |
479 |
480 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
481 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.CountFilter
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | HXL filter to count and aggregate data.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Override hxl.classes.BaseFilter.getColumns to return only the columns for the aggregation report.
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Override hxl.classes.BaseFilter.iterator to return a set of rows with aggregated values.
302 | |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 | Class Detail
319 |
320 |
321 |
322 | hxl.classes.CountFilter(source, patterns, aggregate)
323 |
324 |
325 |
326 | HXL filter to count and aggregate data.
327 |
328 | By default, this filter put out a dataset with the selected tags
329 | and a new tag #meta+count giving the number of times each
330 | combination of values appears. If the aggregate tag pattern is
331 | present, the filter will also produce a column with the sum,
332 | average (mean), minimum, and maximum values for the tag, attaching
333 | the attributes +sum, +avg, +min, and +max to the core tag.
334 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
342 | - Parameters:
343 |
344 | -
345 | source
346 |
347 |
348 | - the HXL data source (may be another filter).
349 |
350 | -
351 | patterns
352 |
353 |
354 | - a list of tag patterns (strings or hxl.classes.TagPattern
355 | objects) whose values make up a shared key.
356 |
357 | -
358 | aggregate
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 |
380 |
381 | Method Detail
382 |
383 |
384 |
385 |
386 |
387 |
388 | getColumns()
389 |
390 |
391 |
392 | Override hxl.classes.BaseFilter.getColumns to return only the columns for the aggregation report.
393 |
394 | Will list the tags that match the patterns provided in the
395 | constructor, as well as a #meta+count tag, and aggregation tags if
396 | the aggregation parameter was included.
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 | - Returns:
410 |
411 | - a list of hxl.classes.Column objects
412 |
413 |
414 |
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 | iterator()
425 |
426 |
427 |
428 | Override hxl.classes.BaseFilter.iterator to return a set of rows with aggregated values.
429 |
430 | Each row represents a unique set of values and the number of times
431 | it occurs.
432 |
433 |
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 | - Returns:
445 |
446 | - an iterator over the aggregated data.
447 |
448 |
449 |
450 |
451 |
452 |
453 |
454 |
455 |
456 |
457 |
458 |
459 |
460 |
461 |
466 |
467 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
468 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.Row
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | Wrapper for a row of HXL data.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Make a deep copy of a row's values (not the columns).
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Look up the first value that matches a tag pattern.
302 | |
303 |
304 |
305 |
306 | | |
307 |
308 |
310 | Look up all values that match a tag pattern.
311 | |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | Class Detail
328 |
329 |
330 |
331 | hxl.classes.Row(values, columns)
332 |
333 |
334 |
335 | Wrapper for a row of HXL data.
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 | - Parameters:
345 |
346 | -
347 | values
348 |
349 |
350 |
351 |
352 | -
353 | columns
354 |
355 |
356 |
357 |
358 |
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 | Method Detail
377 |
378 |
379 |
380 |
386 |
387 | Make a deep copy of a row's values (not the columns).
388 |
389 | This method is especially useful for filters.
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 | - Returns:
403 |
404 | - {hxl.classes.Row} a new row object.
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 |
415 |
416 |
417 | get(pattern)
418 |
419 |
420 |
421 | Look up the first value that matches a tag pattern.
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 | - Parameters:
431 |
432 | -
433 | pattern
434 |
435 |
436 | - The tag pattern to use.
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 | - Returns:
446 |
447 | - a string value, or null if none found.
448 |
449 |
450 |
451 |
452 |
453 |
454 |
455 |
456 |
457 |
458 |
459 |
460 | getAll(pattern)
461 |
462 |
463 |
464 | Look up all values that match a tag pattern.
465 |
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 | - Parameters:
474 |
475 | -
476 | pattern
477 |
478 |
479 | - The tag pattern to use.
480 |
481 |
482 |
483 |
484 |
485 |
486 |
487 |
488 | - Returns:
489 |
490 | - a possibly-empty array of string values (or nulls).
491 |
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 |
505 |
510 |
511 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
512 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.Column
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | Wrapper for a HXL column definition.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Create a deep copy of this column spec.
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Create a display tagspec for the column.
302 | |
303 |
304 |
305 |
306 | | <static> |
307 |
308 | hxl.classes.Column. parse(spec, header, useException)
309 | Parse a tag spec into its parts.
311 | |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | Class Detail
328 |
329 |
330 |
331 | hxl.classes.Column(tag, attributes, header)
332 |
333 |
334 |
335 | Wrapper for a HXL column definition.
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 | - Parameters:
345 |
346 | -
347 | tag
348 |
349 |
350 |
351 |
352 | -
353 | attributes
354 |
355 |
356 |
357 |
358 | -
359 | header
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 | - See:
374 |
375 | - hxl.classes.TagPattern
376 |
377 |
378 |
379 |
380 |
381 |
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 | Method Detail
390 |
391 |
392 |
393 |
399 |
400 | Create a deep copy of this column spec.
401 |
402 | This method is mainly useful for filters that want to modify a column.
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 |
415 | - Returns:
416 |
417 | - {hxl.classes.Column} A deep copy of this columns spec.
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 | getDisplayTag()
431 |
432 |
433 |
434 | Create a display tagspec for the column.
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 |
450 |
451 |
452 |
<static>
453 |
454 |
455 | hxl.classes.Column.parse(spec, header, useException)
456 |
457 |
458 |
459 | Parse a tag spec into its parts.
460 |
461 |
462 |
463 |
464 |
465 |
466 |
467 |
468 | - Parameters:
469 |
470 | -
471 | spec
472 |
473 |
474 |
475 |
476 | -
477 | header
478 |
479 |
480 |
481 |
482 | -
483 | useException
484 |
485 |
486 |
487 |
488 |
489 |
490 |
491 |
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 |
505 |
510 |
511 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
512 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.Dataset
232 |
233 |
234 |
235 |
236 |
237 |
Extends
238 | hxl.classes.Source.
239 |
240 |
241 |
242 |
243 |
244 |
Defined in: hxl.js.
245 |
246 |
247 |
248 |
249 |
250 |
251 | Class Summary
252 |
253 |
254 | | Constructor Attributes |
255 | Constructor Name and Description |
256 |
257 |
258 |
259 |
260 | | |
261 |
262 |
265 | An original HXL dataset (including the raw data)
266 | Derived from hxl.classes.Source
267 | |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 |
279 |
280 | - Fields borrowed from class hxl.classes.Source:
- columns, displayTags, headers, rows, tags
281 |
282 |
283 |
284 |
285 |
286 |
287 |
288 |
289 |
290 | Method Summary
291 |
292 |
293 | | Method Attributes |
294 | Method Name and Description |
295 |
296 |
297 |
298 |
299 |
300 | | |
301 |
302 |
304 | Get an array of column definitions.
305 | |
306 |
307 |
308 |
309 | | |
310 |
311 |
313 | Get an iterator through all the rows in the dataset.
314 | |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 | - Methods borrowed from class hxl.classes.Source:
- cache, count, each, forEach, getDisplayTags, getHeaders, getMatchingColumns, getMax, getMin, getRows, getTags, getValues, hasColumn, index, isNumbery, rename, withColumns, withoutColumns, withoutRows, withRows
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 | Class Detail
335 |
336 |
337 |
338 | hxl.classes.Dataset(rawData)
339 |
340 |
341 |
342 | An original HXL dataset (including the raw data)
343 | Derived from hxl.classes.Source
344 |
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 | - Parameters:
353 |
354 | -
355 | {array} rawData
356 |
357 |
358 | - An array of arrays of raw strings (tabular).
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 | Method Detail
379 |
380 |
381 |
382 |
383 |
384 |
385 | getColumns()
386 |
387 |
388 |
389 | Get an array of column definitions.
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 | iterator()
411 |
412 |
413 |
414 | Get an iterator through all the rows in the dataset.
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 |
433 |
434 |
435 |
436 |
437 |
442 |
443 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
444 |
185 |
186 |
188 |
189 |
Classes
190 |
223 |
224 |
225 |
228 |
229 |
230 |
231 | Class hxl.classes.TagPattern
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
Defined in: hxl.js.
243 |
244 |
245 |
246 |
247 |
248 |
249 | Class Summary
250 |
251 |
252 | | Constructor Attributes |
253 | Constructor Name and Description |
254 |
255 |
256 |
257 |
258 | | |
259 |
260 |
263 | A compiled pattern for matching HXL columns.
264 | |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Method Summary
279 |
280 |
281 | | Method Attributes |
282 | Method Name and Description |
283 |
284 |
285 |
286 |
287 |
288 | | |
289 |
290 |
292 | Test if a column matches this pattern.
293 | |
294 |
295 |
296 |
297 | | |
298 |
299 |
301 | Test if a tag pattern matches any columns in a list.
302 | |
303 |
304 |
305 |
306 | | <static> |
307 |
308 | hxl.classes.TagPattern. parse(pattern, useException)
309 | Parse a string into a tag pattern.
311 | |
312 |
313 |
314 |
315 |
316 |
317 |
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | Class Detail
328 |
329 |
330 |
331 | hxl.classes.TagPattern(tag, includeAttributes, excludeAttributes, isAbsolute)
332 |
333 |
334 |
335 | A compiled pattern for matching HXL columns.
336 |
337 |
You should not normally call this constructor directly. All
338 | functions that use a pattern compile it as needed, so you can stick
339 | with strings. If you want to precompile a pattern, use the static
340 | #parse method.
341 |
342 |
The other useful method in this class is #match, with
343 | tests the pattern against a hxl.classes.Column.
344 |
345 |
A pattern specification looks like a normal HXL hashtag and
346 | attributes, except that it can contain "-" attributes as well as
347 | "+" attributes. For example, the following pattern matches any
348 | column with the tag "#org", the attribute "+funder", and *not* the
349 | attribute "+impl" (any other attributes are ignored):
350 |
351 |
352 | #org+funder-impl
353 |
354 |
355 |
More examples:
356 |
357 |
#adm1 will match the following: #adm1, #adm1+code, #adm1+fr,
358 | #adm1+name, etc.
359 |
360 |
#adm1-code will match #adm1, #adm1+fr, and #adm1+name,
361 | but *not* #adm1+code (because the +code attribute is explicitly
362 | forbidden).
363 |
364 |
#adm1+name-fr will match #adm1+name or #adm1+name+en, but
365 | not #adm1+name+fr
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 | - Parameters:
375 |
376 | -
377 | {string} tag
378 |
379 |
380 | - The basic tag to use in the pattern, with the
381 | leading '#'
382 |
383 | -
384 | {array} includeAttributes
385 |
386 |
387 | - A (possibly-empty) list of
388 | attribute names that must be present, without the leading '+'
389 |
390 | -
391 | {array} excludeAttributes
392 |
393 |
394 | - A (possibly-empty) list of
395 | attribute names that must *not* be present, without the leading '+'
396 |
397 | -
398 | isAbsolute
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 | - See:
413 |
414 | - hxl.classes.Column
415 |
416 |
417 |
418 |
419 |
420 |
421 |
422 |
423 |
424 |
425 |
426 |
427 |
428 | Method Detail
429 |
430 |
431 |
432 |
433 |
434 | {boolean}
435 | match(column)
436 |
437 |
438 |
439 | Test if a column matches this pattern.
440 |
441 |
442 | data.columns.forEach(function(col) {
443 | if (pattern.match(col)) {
444 | console.log("Found a match: " + col.displayTag);
445 | }
446 | });
447 |
448 |
449 | This method is used heavily in the filter classes.
450 |
451 |
452 |
453 |
454 |
455 |
456 |
457 |
458 | - Parameters:
459 |
460 | -
461 | {hxl.classes.Column} column
462 |
463 |
464 | - The column to test.
465 |
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 | - Returns:
474 |
475 | - {boolean} true on match, false otherwise.
476 |
477 |
478 |
479 |
480 |
481 |
482 |
483 |
484 |
485 |
486 |
487 |
488 | matchList(columns)
489 |
490 |
491 |
492 | Test if a tag pattern matches any columns in a list.
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 | - Parameters:
502 |
503 | -
504 | columns
505 |
506 |
507 |
508 |
509 |
510 |
511 |
512 |
513 |
514 |
515 |
516 |
517 |
518 |
519 |
520 |
521 |
<static>
522 |
523 |
524 | hxl.classes.TagPattern.parse(pattern, useException)
525 |
526 |
527 |
528 | Parse a string into a tag pattern.
529 |
530 |
531 | var pattern = hxl.classes.TagPattern.parse('#org+funder-impl');
532 |
533 |
534 | It is safe to pass an already-compiled
hxl.classes.TagPattern
535 | to this method; it will simple be returned as-is.
536 |
537 |
538 |
539 |
540 |
541 |
542 |
543 |
544 | - Parameters:
545 |
546 | -
547 | {string} pattern
548 |
549 |
550 | - a tag-pattern string, like "#org+funder-impl"
551 |
552 | -
553 | useException
554 |
555 |
556 | - (optional) throw an exception on failure.
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 |
565 | - Returns:
566 |
567 | - a hxl.classes.TagPattern, or null if parsing fails (and useException is false).
568 |
569 |
570 |
571 |
572 |
573 |
574 |
575 |
576 |
577 |
578 |
579 |
580 |
581 |
582 |
587 |
588 | Documentation generated by
JsDoc Toolkit 2.4.0 on Sat Jun 30 2018 17:05:53 GMT-0400 (EDT)
589 |