☝️Small business or a startup? See if you qualify for our special offer.
+
All documentation
  • API Reference for older versions
  • clearFilter

    clearFilter(uniqueName: String)

    [starting from version: 1.4]

    Clears the filter which was applied previously to the specified field.

    Parameters

    Parameter/TypeDescription
    uniqueName
    String
    The field’s unique name.

    Example

    pivot.setFilter("Country",
      {
        "members": [
          "country.[poland]",
          "country.[uk]",
          "country.[ukraine]",
        ]
      }
    );
    pivot.getFilter("Country");
    
    /*
    method getFilter() returns the following Object:
    {
      "members": [
        "country.[poland]",
        "country.[uk]",
        "country.[ukraine]"
      ]
    }
    */
    
    pivot.clearFilter("Country");
    
    pivot.getFilter("Country");
    /*
    after clearFilter() call, method getFilter() returns null:
    null
    */

    Open the example on JSFiddle.

    See also

    getFilter
    setFilter