ValueQueryObject

Refers to the filter by value. Works only for fields in rows or columns. Check if the value filter is supported for your data source in Flexmonster’s technical specifications.

Properties

Only one property can be specified at a time.

Note MDX queries are not supported by the value filter. Use only the properties described in this section.

Property/Type	Description
top Number	Returns X members with the greatest values, where X is a number you specify. Example: { "top": 5 }.
bottom Number	Returns X members with the lowest values, where X is a number you specify. Example: { "bottom": 5 }.
equal Number	Returns members with values equal to the specified value. Example: { "equal": 5 }.
not_equal Number	Returns members with values not equal to the specified value. Example: { "not_equal": 5 }.
greater Number	Returns members with values greater than the specified value. Example: { "greater": 5 }.
greater_equal Number	Returns members with values greater than or equal to the specified value. Example: { "greater_equal": 5 }.
less Number	Returns members with values less than the specified value. Example: { "less": 5 }.
less_equal Number	Returns members with values less than or equal to the specified value. Example: { "less_equal": 5 }.
between Number[]	Returns members with values between two values (including them). Example: { "between": [0, 5] }.
not_between Number[]	Returns members with values not between two values (excluding them). Example: { "not_between": [0, 5] }.

Example

The example below shows how the ValueQueryObject is used to create a value filter:

slice: {
  rows: [
    {
      uniqueName: "Country",
      filter: {
        measure: {
          uniqueName: "Price",
          aggregation: "sum",
        },
        query: {
          top: 5,
        },
      },
    },
  ]
}

Try a live sample on JSFiddle.

See also

Filter by value
FilterObject
setFilter()
clearFilter()