Browse Source

Fixed #339: Added a method `refresh()` to the `DataView`, to update filter results

v3_develop
jos 9 years ago
parent
commit
c4d357dd85
4 changed files with 112 additions and 0 deletions
  1. +1
    -0
      HISTORY.md
  2. +16
    -0
      docs/dataview.html
  3. +42
    -0
      lib/DataView.js
  4. +53
    -0
      test/DataView.test.js

+ 1
- 0
HISTORY.md View File

@ -13,6 +13,7 @@ http://visjs.org
- Added property `length` holding the total number of items to the `DataSet` - Added property `length` holding the total number of items to the `DataSet`
and `DataView`. and `DataView`.
- Added a method `refresh()` to the `DataView`, to update filter results.
### Timeline ### Timeline

+ 16
- 0
docs/dataview.html View File

@ -219,6 +219,22 @@ var data = new vis.DataView(dataset, options)
</td> </td>
</tr> </tr>
<tr>
<td>refresh()</td>
<td>none</td>
<td>
Refresh the filter results of a DataView. Useful when the filter function contains dynamic properties, like:
<pre class="prettyprint lang-js">var data = new vis.DataSet(...);
var view = new vis.DataView(data, {
filter: function (item) {
return item.value > threshold;
}
});</pre>
In this example, <code>threshold</code> is an external parameter. When the value of <code>threshold</code> changes, the DataView must be notified that the filter results may have changed by calling <code>DataView.refresh()</code>.
</td>
</tr>
<tr> <tr>
<td> <td>
setDataSet(data) setDataSet(data)

+ 42
- 0
lib/DataView.js View File

@ -79,6 +79,48 @@ DataView.prototype.setData = function (data) {
} }
}; };
/**
* Refresh the DataView. Useful when the DataView has a filter function
* containing a variable parameter.
*/
DataView.prototype.refresh = function () {
var id;
var ids = this._data.getIds({filter: this._options && this._options.filter});
var newIds = {};
var added = [];
var removed = [];
// check for additions
for (var i = 0; i < ids.length; i++) {
id = ids[i];
newIds[id] = true;
if (!this._ids[id]) {
added.push(id);
this._ids[id] = true;
this.length++;
}
}
// check for removals
for (id in this._ids) {
if (this._ids.hasOwnProperty(id)) {
if (!newIds[id]) {
removed.push(id);
delete this._ids[id];
this.length--;
}
}
}
// trigger events
if (added.length) {
this._trigger('add', {items: added});
}
if (removed.length) {
this._trigger('remove', {items: removed});
}
};
/** /**
* Get data from the data view * Get data from the data view
* *

+ 53
- 0
test/DataView.test.js View File

@ -94,4 +94,57 @@ describe('DataView', function () {
assert.equal(group2.length, 0); assert.equal(group2.length, 0);
}); });
it('should refresh a DataView with filter', function () {
var data = new DataSet([
{id:1, value:2},
{id:2, value:4},
{id:3, value:7}
]);
var threshold = 5;
// create a view. The view has a filter with a dynamic property `threshold`
var view = new DataView(data, {
filter: function (item) {
return item.value < threshold;
}
});
var added, updated, removed;
view.on('add', function (event, props) {added = added.concat(props.items)});
view.on('update', function (event, props) {updated = updated.concat(props.items)});
view.on('remove', function (event, props) {removed = removed.concat(props.items)});
assert.deepEqual(view.get(), [
{id:1, value:2},
{id:2, value:4}
]);
// change the threshold to 3
added = [];
updated = [];
removed = [];
threshold = 3;
view.refresh();
assert.deepEqual(view.get(), [{id:1, value:2}]);
assert.deepEqual(added, []);
assert.deepEqual(updated, []);
assert.deepEqual(removed, [2]);
// change threshold to 8
added = [];
updated = [];
removed = [];
threshold = 8;
view.refresh();
assert.deepEqual(view.get(), [
{id:1, value:2},
{id:2, value:4},
{id:3, value:7}
]);
assert.deepEqual(added, [2, 3]);
assert.deepEqual(updated, []);
assert.deepEqual(removed, []);
})
}); });

Loading…
Cancel
Save