new module:models/ProductSearchRefinement(attributeId)
Constructs a new ProductSearchRefinement.
Document representing a product search refinement attribute.
Parameters:
| Name | Type | Description |
|---|---|---|
attributeId |
String | The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix "c_" (for example, "c_refinementColor"). In the case of a category refinement, the id must be "cgid". In the case of a price refinement, the id must be "price". |
- Source:
Members
(inner) attribute_id :String
The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix "c_" (for example, "c_refinementColor"). In the case of a category refinement, the id must be "cgid". In the case of a price refinement, the id must be "price".
Type:
- String
- Source:
(inner) label :String
The localized label of the refinement.
Type:
- String
- Source:
(inner) values :Array.<module:models/ProductSearchRefinementValue>
The sorted array of refinement values. This array can be empty.
Type:
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ProductSearchRefinement}
Constructs a ProductSearchRefinement from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/ProductSearchRefinement | Optional instance to populate. |
- Source:
Returns:
The populated ProductSearchRefinement instance.