Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 11

changes.mady.by.user user-3484a

Saved on

compared with

New Version 12

changes.mady.by.user user-3484a

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 


Property Reference

No properties associated with the Filter object need to be accessed to utilise the API functionality.

Function Reference

getFilter(filterId)

Returns

FilterObject

Description

Fetches a FilterObject for the passed filterId. If there is no matching filterId then null will be returned.

Parameters

filterId - (String, Number) 

The Name or the UUID of the filter you wish to access.

Examples

Get the filter named “Demographic”

let filter = filters.get('Demographic');
console.log(filter.name, filter.uuid); //Output the name of the filter as well as its UUID


Get the filter by UUID

let filter = filters.get('47fe96c2-5101-4b0d-9018-7d12a84d3519');
console.log(filter.name, filter.uuid); //Output the name of the filter as well as its UUID