bokeh.models.filters¶
-
class
BooleanFilter
(*args, **kw)[source]¶ Bases:
bokeh.models.filters.Filter
A
BooleanFilter
filters data by returning the subset of data corresponding to indices where the values of the booleans array is True.
-
class
CustomJSFilter
(*args, **kw)[source]¶ Bases:
bokeh.models.filters.Filter
Filter data sources with a custom defined JavaScript function.
Warning
The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.
-
args
¶ property type:
Dict
(String
,AnyRef
)A mapping of names to Python objects. In particular those can be bokeh’s models. These objects are made available to the callback’s code snippet as the values of named parameters to the callback.
-
code
¶ property type:
String
A snippet of JavaScript code to filter data contained in a columnar data source. The code is made into the body of a function, and all of of the named objects in
args
are available as parameters that the code can use. The variablesource
will contain the data source that is associated with theCDSView
this filter is added to.The code should either return the indices of the subset or an array of booleans to use to subset data source rows.
Example:
code = ''' var indices = []; for (var i = 0; i <= source.data['some_column'].length; i++){ if (source.data['some_column'][i] == 'some_value') { indices.push(i) } } return indices; '''
Note
Use
CustomJS.from_coffeescript()
for CoffeeScript source code.
-
classmethod
from_coffeescript
(code, args={})[source]¶ Create a
CustomJSFilter
instance from CoffeeScript snippets. The function bodies are translated to JavaScript functions using node and therefore require return statements.The
code
function namespace will contain the variablesource
at render time. This will be the data source associated with theCDSView
that this filter is added to.
-
classmethod
from_py_func
(func)[source]¶ Create a
CustomJSFilter
instance from a Python function. The function is translated to JavaScript using PScript.The
func
function namespace will contain the variablesource
at render time. This will be the data source associated with theCDSView
that this filter is added to.
-
-
class
Filter
(*args, **kw)[source]¶ Bases:
bokeh.model.Model
A Filter model represents a filtering operation that returns a row-wise subset of data when applied to a
ColumnDataSource
.
-
class
GroupFilter
(*args, **kw)[source]¶ Bases:
bokeh.models.filters.Filter
A
GroupFilter
represents the rows of aColumnDataSource
where the values of the categorical column column_name match the group variable.