new module:models/ContentSearchRefinementValue()
Constructs a new ContentSearchRefinementValue.
Document representing a search refinement value.
Members
(inner) description :String
The localized description of the refinement value.
Type:
- String
(inner) hit_count :Number
The number of search hits (0 or more) when selecting the refinement value.
Type:
- Number
(inner) label :String
The localized label of the refinement value.
Type:
- String
(inner) presentation_id :String
The optional presentation id associated with the refinement value. The presentation id can be used, for example, to associate an id with an HTML widget.
Type:
- String
(inner) value :String
The refinement value. In the case of an attribute refinement, this is the bucket, the attribute value, or a value range. In the case of a content folder refinement, this is the folder id.
Type:
- String
(inner) values :Array.<module:models/ContentSearchRefinementValue>
The array of hierarchical refinement values. This array can be empty.
Type:
Methods
(static) constructFromObject(data, obj) → {module:models/ContentSearchRefinementValue}
Constructs a ContentSearchRefinementValue 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/ContentSearchRefinementValue | Optional instance to populate. |
Returns:
The populated ContentSearchRefinementValue instance.