Class TimeMapFilterChain

TimeMapFilterChains hold a set of filters to apply to the map or timeline.

Constructor

TimeMapFilterChain(timemap, fon, foff, pre, post)

	Field
	chain :{Function[]} Chain of filter functions, each taking an item and returning a boolean
	timemap :{TimeMap} Reference to parent TimeMap

	Method
	add(f) Add a filter to the filter chain.
	off() Function to run on an item if filter is false
	on() Function to run on an item if filter is true
	post() Function to run after the filter runs
	pre() Function to run before the filter runs
	remove(f) Remove a filter from the filter chain
	run() Run filters on all items

Class Detail

TimeMapFilterChain(timemap, fon, foff, pre, post)

Parameters (optional)
timemap	{TimeMap}	Reference to the timemap object
fon	{Function}	Function to run on an item if filter is true
foff	{Function}	Function to run on an item if filter is false
pre	{Function}	Function to run before the filter runs
post	{Function}	Function to run after the filter runs

Field Details

chain :{Function[]}

Chain of filter functions, each taking an item and returning a boolean

timemap :{TimeMap}

Reference to parent TimeMap

Method Details

add(f)

Add a filter to the filter chain.

Parameters (optional)
f	{Function}	Function to add

off()

Function to run on an item if filter is false

on()

Function to run on an item if filter is true

post()

Function to run after the filter runs

pre()

Function to run before the filter runs

remove(f)

Remove a filter from the filter chain

Parameters (optional)
f	{Function}	Function to remove; if not supplied, the last filter added is removed

run()

Run filters on all items