Filters

The Filters object represents list filters in the storefront.

classDiagram
  direction LR
  Filters --> AttributesFiltersList
  Filters --> OptionsFiltersList
  Filters --> PriceFilter
  Filters --> CategoriesFilter
  Filters --> ProducersFilter
  Filters --> CollectionsFilter
  Filters --> AvailabilitiesFilter
  Filters --> Filter
  Filters --> Url
  class Filters{
    AttributesFiltersList attributesFilter
    OptionsFiltersList optionsFilter
    PriceFilter priceFilter
    CategoriesFilter categoriesFilter
    ProducersFilter producersFilter
    CollectionsFilter collectionsFilter
    AvailabilitiesFilter availabilitiesFilter
    Filter deliveriesFilter
    Filter promotionsFilter
    Filter ratesFilter
    Filter newsFilter
    int activeFiltersCount
    Url baseUrl
  }
  class AttributesFiltersList{
  }
  class OptionsFiltersList{
  }
  class PriceFilter{
  }
  class CategoriesFilter{
  }
  class ProducersFilter{
  }
  class CollectionsFilter{
  }
  class AvailabilitiesFilter{
  }
  class Filter{
  }
  class Url{
  }

Properties

Attribute name	Type	Description
attributesFilter	null|AttributesFiltersList	Returns AttributesFiltersList object that represents list of AttributeFilter object.
optionsFilter	null|OptionsFiltersList	The OptionsFiltersList object that represents list of OptionFilter object.
priceFilter	null|PriceFilter	The PriceFilter object that represents a price filter.
categoriesFilter	null|CategoriesFilter	The CategoriesFilter object that represents a categories filter.
producersFilter	null|ProducersFilter	The ProducersFilter object that represents a producers filter.
collectionsFilter	null|CollectionsFilter	The CollectionsFilter object that represents a collections filter.
availabilitiesFilter	null|AvailabilitiesFilter	The AvailabilitiesFilter object that represents an availabilities filter.
deliveriesFilter	null|AttributesFiltersList	The Filter object that represents a deliveries filter.
promotionsFilter	null|Filter	The Filter object that represents a promotions filter.
ratesFilter	null|Filter	The Filter object that represents a rates filter.
newsFilter	null|Filter	The Filter object that represents a news filter.
activeFiltersCount	int	Returns the number of currently active filter groups.
baseUrl	Url	The Url object that represents a base URL.

attributesFilter property

sourceoutput

{{ filters.attributesFilter.name }}

name of attributes filter

optionsFilter property

sourceoutput

{{ filters.optionsFilter.name }}

name of options filter

priceFilter property

sourceoutput

{{ filters.priceFilter.name }}

name of price filter

categoriesFilter property

sourceoutput

{{ filters.categoriesFilter.name }}

name of categories filter

producersFilter property

sourceoutput

{{ filters.producersFilter.name }}

name of producers filter

collectionsFilter property

sourceoutput

{{ filters.collectionsFilter.name }}

name of collections filter

availabilitiesFilter property

sourceoutput

{{ filters.availabilitiesFilter.name }}

name of availabilities filter

deliveriesFilter property

sourceoutput

{{ filters.deliveriesFilter.name }}

name of deliveries filter

promotionsFilter property

sourceoutput

{{ filters.promotionsFilter.name }}

name of promotions filter

ratesFilter property

sourceoutput

{{ filters.ratesFilter.name }}

name of rates filter

newsFilter property

sourceoutput

{{ filters.newsFilter.name }}

name of news filter

activeFiltersCount property

sourceoutput

{{ filters.activeFiltersCount }}

3

baseUrl property

sourceoutput

{{ filters.baseUrl }}

/base/url