CategoryFilterOption

Extends Object. A CategoryFilterOption represents an option for a CategoryFilter and usually present for categories that enable filtering of product results on a page governed by a category controller.

Properties
count

Type Number | null

The number of products available with this filter option. If a count is unavailable then the value of count is null..

id

Type NumberString

The id of a filter is dependent upon its type. For specification and manufacturer filters the id represents their System ID as a Number. However price based filters have an id which is made up of the minValue and maxValue.

isActive

Type Boolean

Indicates whether the filter option has been selected - true if yes, else false.

isCheckbox

Type Boolean

True if the widget required for the option should be of a checkbox style (i.e. multi-selection from a list), else false.

isRadio

Type Boolean

True if the widget required for the option should be in the style of a radio button (i.e. single selection from a list), else false.

isRange

Type Boolean

True if the widget required for the option should be represented as an interactive slider with a minimum and maximum value selection available, else false.

isSelect

Type Boolean

True if the widget required for the option should be in the style of a select box/dropdown (i.e. single selection from a drop-down list), else false.

isSlider

Type Boolean

True if the widget required for the option should be represented as an interactive slider with a single value between a minimum and maximum available, else false.

max

Type Number | Money | null

The maximum limit of a numeric range.

maxValue

Type Number | Money | null

The maximum value of a numeric range selected by a user (must be less than or equal to max).

min

Type Number | Money | null

The minimum limit of a numeric range.

minValue

Type Number | Money | null

The minimum value of a numeric range select by a user (must be greater than or equal to min).

type

Type String

The type of filter option:

  • manufacturer
  • price
  • spec
url

Type Url | null

The Url for the filter option, which is used when rendering selection lists.

value

Type String | ProductSpecificationValue

If the filter type is spec, then the value returned is the ProductSpecificationValue object.
Else the value of the filter is represented as a String.

widget

Type String

The style of widget to display for the filter option. Currently these are:

  • checkbox
  • radio
  • range
  • select
  • slider