new module:models/ContentSearchRefinement(attributeId)
Constructs a new ContentSearchRefinement.
Document representing a 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_". |
- 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_".
Type:
- String
- Source:
(inner) label :String
The localized label of the refinement.
Type:
- String
- Source:
(inner) values :Array.<module:models/ContentSearchRefinementValue>
The sorted array of refinement values. The array can be empty.
Type:
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ContentSearchRefinement}
Constructs a ContentSearchRefinement 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/ContentSearchRefinement | Optional instance to populate. |
- Source:
Returns:
The populated ContentSearchRefinement instance.