- Theme Engine
- Templates
- EVML Reference
- Output
- Comments
- Operators
- Statements and Declarations
- Built-in Functions
- Built-in Objects
- Account
- Address
- Array
- Boolean
- Branch
- Cart
- CartLine
- Category
- CategoryCollection
- CategoryFilter
- CategoryFilterCollection
- CategoryFilterOption
- CategorySearch
- Collection
- Color
- Contact
- Currency
- Date
- Discount
- Dom
- Event
- EventCollection
- EventSlot
- Image
- Layout
- Locale
- Money
- Number
- Object
- Page
- PageCollection
- PageSearch
- PageSharer
- Pagination
- Postage
- Price
- PriceDiscount
- Product
- ProductCollection
- ProductCustomisation
- ProductDownload
- ProductMedia
- ProductMediaFrame
- ProductPrice
- ProductSearch
- ProductSpecification
- ProductSpecificationValue
- ProductVariation
- ProductVariationOption
- RecentlyViewed
- RegExp
- Request
- Review
- ReviewCollection
- Search
- SearchCollection
- SearchResult
- String
- Tag
- Template
- Url
- Website
- EV Tags
- CSS Pre-processor
- Ajax API
CategoryFilter
Extends Object. Category filters describe the type of filter and the available options for the filter to narrow the product results within a category. Filters are obtained when calling the category.filters() method.
| Properties | |
|---|---|
| description |
Type String The description for the product specification the filter is based upon. |
| id |
Type Number The System ID for the filter if of type |
| isActive |
Type Boolean Indicates whether any of the options for this filter have been selected - true if yes, else false. |
| isCheckbox |
Type Boolean True if the widget required for options should be of a checkbox style (i.e. multi-selection from a list), else false. |
| isManufacturer |
Type Boolean True if this is a manufacturer based filter, else false. |
| isPrice |
Type Boolean True if this is a price based filter, else false. |
| isRadio |
Type Boolean True if the widget required for options should be of a radio button style (i.e. single selection from a list), else false. |
| isSelect |
Type Boolean True if the widget required for options should be of a select box/dropdown style (i.e. single selection from a drop-down list), else false. |
| isSlider |
Type Boolean True if the widget required for options should be represented as an interactive slider with a single value between a minimum and maximum available, else false. |
| isSpecification |
Type Boolean True if this is a product specification based filter, else false. |
| isString |
Type Boolean True if this is a product specification based filter, and the product specification is of type |
| isSwatch |
Type Boolean True if this is a product specification based filter, and the product specification is of type |
| isRange |
Type Boolean True if the widget required for options should be represented as an interactive slider with a minimum and maximum value selection available, else false. |
| options |
Type Array The available options for the filter. Each element within the Array contains a CategoryFilterOption |
| title |
Type String The title of a filter is either the default title for the type of filter (such as Price or Manufacturer), or is the title of the specification used to build the filter. |
| type |
Type String The type of filter, which may currently be one of the following supported types:
|
| widget |
Type String The style of widget to display for the filter options. Currently these are:
|