bokeh.models.filters¶
-
class
bokeh.models.filters.BooleanFilter(*args, **kw)¶ Bases:
bokeh.models.filters.FilterA BooleanFilter filters data by returning the subset of data corresponding to indices where the values of the booleans array is True.
-
class
bokeh.models.filters.CustomJSFilter(*args, **kw)¶ Bases:
bokeh.models.filters.FilterFilter data sources with a custom defined JavaScript function.
-
args¶ property type:
Dict(String,Instance(Model) )A mapping of names to Bokeh plot objects. These objects are made available to the callback code snippet as the values of named parameters to the callback.
-
code¶ property type:
StringA 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
argsare available as parameters that the code can use. The variablesourcewill contain the data source that is associated with the CDSView 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={})¶ Create a CustomJSFilter instance from CoffeeScript snippets. The function bodies are translated to JavaScript functions using node and therefore require return statements.
The
codefunction namespace will contain the variablesourceat render time. This will be the data source associated with the CDSView that this filter is added to.
-
classmethod
from_py_func(func)¶ Create a CustomJSFilter instance from a Python function. The fucntion is translated to JavaScript using PyScript.
The
funcfunction namespace will contain the variablesourceat render time. This will be the data source associated with the CDSView that this filter is added to.
-
-
class
bokeh.models.filters.Filter(*args, **kw)¶ Bases:
bokeh.model.ModelA Filter model represents a filtering operation that returns a row-wise subset of data when applied to a ColumnDataSource.
-
class
bokeh.models.filters.GroupFilter(*args, **kw)¶ Bases:
bokeh.models.filters.FilterA GroupFilter represents the rows of a ColumnDataSource where the values of the categorical column column_name match the group variable.
-
class
bokeh.models.filters.IndexFilter(*args, **kw)¶ Bases:
bokeh.models.filters.FilterAn IndexFilter filters data by returning the subset of data at a given set of indices.