Skip to content

ColorOptionsFilterValue

The ColorOptionsFilterValue object represents a color options filter value in the storefront.

classDiagram
  direction LR
  ColorOptionsFilterValue --> Url
  class ColorOptionsFilterValue{
    int optionValueId
    string color
    string name
    bool isActive
    string urlValue
    string urlKey
    Url urlWithFilterValueRemoved
    Url urlWithSingleFilterValue
    ?Url urlWithFilterValueAdded
    ?int counter
  }
  class Url{
  }

Properties

Attribute name Type Description
optionValueId int The id of the option value.
color string The color in the option filter value.
name string The name of the option filter value.
isActive bool Returns true if option filter value is active.
urlValue string Represents a value of the options filter used to build target URL.
urlKey string Represents URL key for options filter value.
counter null|int Represents amount of found products meeting the criteria.
urlWithFilterValueRemoved Url Returns Url object that represents link with options filter value removed.
urlWithSingleFilterValue Url Returns Url object that represents link with single options filter value.
urlWithFilterValueAdded null|Url Returns Url object that represents link with options filter value added.

Examples

optionValueId property

{{ colorOptionsFilterValue.optionValueId }}

1

color property

{{ colorOptionsFilterValue.color }}

rgb(255, 0, 0)

name property

{{ colorOptionsFilterValue.name }}

example name

isActive property

{{ colorOptionsFilterValue.isActive }}

true

urlValue property

{{ colorOptionsFilterValue.urlValue }}

1

urlKey property

{{ colorOptionsFilterValue.urlKey }}

f_collection_92

counter property

{{ colorOptionsFilterValue.counter }}

3

urlWithFilterValueRemoved property

{{ colorOptionsFilterValue.urlWithFilterValueRemoved }}

/url/with/filter/value/removed

urlWithSingleFilterValue property

{{ colorOptionsFilterValue.urlWithSingleFilterValue }}

/url/with/single/filter/value

urlWithFilterValueAdded property

{{ colorOptionsFilterValue.urlWithFilterValueAdded }}

/url/with/filter/value/added