Source Filters #2165
Source Filters #2165
Conversation
…ce. Parameter type checking.
…discard all rows if empty array is passed.
…ry filter methods documentation inside class.
| @@ -0,0 +1,172 @@ | |||
| const _ = require('underscore'); | |||
| const Base = require('./base'); | |||
| const getObjectValue = require('../../../../src/util/get-object-value'); | |||
There was a problem hiding this comment.
Could we add Wepback aliases since we're adding ES6 also?
There was a problem hiding this comment.
Commit and take ownership 😂
src/api/v4/source/dataset.js
Outdated
| @@ -17,9 +18,12 @@ var CartoValidationError = require('../error-handling/carto-validation-error'); | |||
| * @api | |||
| */ | |||
| function Dataset (tableName) { | |||
| Base.apply(this, arguments); | |||
There was a problem hiding this comment.
Should we call this before validating the tableName as it was before?
src/api/v4/source/sql.js
Outdated
| @@ -19,17 +19,20 @@ var CartoError = require('../error-handling/carto-error'); | |||
| * @api | |||
| */ | |||
| function SQL (query) { | |||
| Base.apply(this, arguments); | |||
There was a problem hiding this comment.
Same here, should we call this before checking that query is valid?
| this._internalModel.set('query', query, { silent: true }); | ||
|
|
||
| return this._internalModel._engine.reload() | ||
| .then(() => this._triggerQueryChanged(this, query)) |
There was a problem hiding this comment.
So beautiful with the arrow functions 😍
| }, | ||
| 'invalid-filter': { | ||
| messageRegex: /invalidFilter(.+)/, | ||
| // TODO: Add link to documentation? |
|
I have a proposal to improve error messages because they can be much better than now. https://github.com/CartoDB/carto.js/pull/2165/files/22497bec4bdf3c1693f99661a82ed79c804ee554#diff-f93df9e087fbb4571b84c55dce17abf3R208 My proposal is to include a function in |
|
I've been messing around a little bit with the filters and I think it would be nice to have some helpers like |
This PR contains Carto.JS source filters. This will allow people to filter rows out of their sources, either SQL or Dataset sources.
There are two kind of filters:
And two filter collections, that join child filters in a different way:
All the filters have different parameters, related with the filter type, so that you can filter rows according to the column type.
You can use filters and filters collections as you wish, creating all the filters that you can think of, before and after adding them to a source. These filters are live updated, so whenever you change the filters, the visualization will be updated automatically applying the defined filters.
If you want to know more about the API definition, go to #2141 or read the docs.
This PR includes documentation and filter examples.