Class: module:models/ProductSearchRefinementValue

module:models/ProductSearchRefinementValue()

new module:models/ProductSearchRefinementValue()

Constructs a new ProductSearchRefinementValue. Document representing a product search refinement value.

Source:

Members

(inner) description :String

The localized description of the refinement value.

Type:
  • String
Source:

(inner) hit_count :Number

The number of search hits when selecting the refinement value. Can be 0.

Type:
  • Number
Source:

(inner) label :String

The localized label of the refinement value.

Type:
  • String
Source:

(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
Source:

(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 category refinement, this is the category id. In the case of a price refinement,k this is the price range. Ranges are enclosed by parentheses and separated by ".."; for example, "(100..999)" and "(Aa..Fa)" are valid ranges.

Type:
  • String
Source:

(inner) values :Array.<module:models/ProductSearchRefinementValue>

The array of hierarchical refinement values. This array can be empty.

Type:
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/ProductSearchRefinementValue}

Constructs a ProductSearchRefinementValue 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/ProductSearchRefinementValue

Optional instance to populate.
Source:
Returns:

The populated ProductSearchRefinementValue instance.

Type
module:models/ProductSearchRefinementValue