Page History
...
The filters API is broken into two broad sections.
- The Filters API - this refers to functionality concerned with the filter container object and all of the filters within it (could be one or more filters).
- The Filters Object API - this refers to functionality concerned with an individual filter.
Filters Overview
Filters are used in Yellowfin to restrict the data returned in a report to the exact data that a user is interested in (for example, restricting time periods to just return data for the last quarter, or restricting to a list of countries that a user has responsibility for). You can learn more about filters in general and how to create them in this section.
...
Throughout this reference document and the FilterObject reference document, you will see references to different value objects.
...
dashboard.filters.getFilter('47fe96c2-5101-4b0d-9018-7d12a84d3519'); //Will return null |
...
Anchor filtersapi filtersapi
Property Reference
No properties associated with the Filter object need to be accessed to utilise the API functionality.
...
getFilter(filterId)
Returns
Description
Fetches a FilterObject for the passed filterId. If there is no matching filterId then null will be returned.
...
getAllFilters()
Returns
Object - {String, FilterObject}
Description
Returns an Object that contains all of the user prompt filters for the content that the FiltersAPI is attached to. This object is keyed by Filter UUID.
...
- eventName - String - The name of the event that has been triggered.
- filterEvents - Array{Object} - An array of events that comprised this filter list change event. The object will contain at least the following.
- uuid - UUID of the filter that changed.
- filter - FilterObject that caused this event to trigger.
- Certain other filter events can contain more information. You can see the documentation in FilterObject for more in depth details on the Event object for each event.
...
Triggered when any of the FilterObjects within the FiltersAPI are reset.
...