Namespace TimeMap.filters

Defined in:: timemap.js

Namespace for different filter functions. Adding new filters to this object allows them to be specified by string name.

    TimeMap.init({
        options: {
            mapFilter: "hideFuture"
        },
        // etc...
    });

Static Methods

	Method
	TimeMap.filters.hideFuture(item) Static filter function: Hide items later than the visible area of the timeline.
	TimeMap.filters.hidePastFuture(item) Static filter function: Hide items not in the visible area of the timeline.
	TimeMap.filters.none(item) Convenience function: Do nothing.
	TimeMap.filters.showMomentOnly(item) Static filter function: Hide items not present at the exact center date of the timeline (will only work for duration events).

Namespace Detail

TimeMap.filters

Static Method Details

TimeMap.filters.hideFuture(item) :{Boolean}

Static filter function: Hide items later than the visible area of the timeline.

Parameters (optional)
item	{TimeMapItem}	Item to test for filter

Returns:: {Boolean} Whether to show the item

TimeMap.filters.hidePastFuture(item) :{Boolean}

Static filter function: Hide items not in the visible area of the timeline.

Parameters (optional)
item	{TimeMapItem}	Item to test for filter

Returns:: {Boolean} Whether to show the item

TimeMap.filters.none(item) :{Boolean}

Convenience function: Do nothing. Can be used as a setting for mapFilter in TimeMap.init() options, if you don't want map items to be hidden or shown based on the timeline position.

Parameters (optional)
item	{TimeMapItem}	Item to test for filter

Returns:: {Boolean} Whether to show the item

TimeMap.filters.showMomentOnly(item) :{Boolean}

Static filter function: Hide items not present at the exact center date of the timeline (will only work for duration events).

Parameters (optional)
item	{TimeMapItem}	Item to test for filter

Returns:: {Boolean} Whether to show the item

Timemap.js v.1.6

Namespace TimeMap.filters

Static Methods