Name | Type | Default value | Description |
|---|---|---|---|
id | string | Unique sub-identifier of this view. Will be concatenated to the facet's id. Used in Mashup-Builder and client applications to identify the facet. | |
sortFunction | enum(count, relevancy, alphanum, num, range, date, aggregation, explicit, lat, lng) | count | Specifies a sorting function: • Aggregation Value: Sorts the categories using one of the aggregation functions specified in "Aggregations". The "Function Name" field that appears below, lets you enter the aggregation function name. Default sorting direction is descending. • Alphanum: Sorts the categories lexicographically. The category path is used here, not the title. Default sorting direction is ascending. • Count: Sorts the categories by decreasing order, with the number of documents matching the query and having this facet. • Date: Sorts the categories by: ◦ Default with decreasing year, increasing month, increasing day ◦ Reverse with increasing year, decreasing month, decreasing day • Explicit order: Sorts the categories using an explicit order. The "Explicit order" field that appears below, lets you specify a comma-separated list of values. • Latitude: Sorts the categories by latitude, using the average of points. • Longitude: Sorts the categories by longitude, using the average of points. • Num: Tries to parse the category path as an integer, and sorts decreasingly. If the category is prefixed by a number it will parse the prefix. In case of failure, it fallbacks to lexicographical sorting. Default sorting direction is ascending. • Range: If the categories are ranges in the form [a;b] (as for NumericalFacet), it sorts the categories per increasing midrange value. Default sorting direction is ascending. • Relevance: Sorts the categories by decreasing relevance. Relevance is defined by taking into account both the number of documents matching the query and having this facet, and the total number of documents having the facet. The idea is to use a method of ponderation similar to the classical TF-IDF. |
aggregateScores | boolean | If selected, the category score will be the sum of the scores of all its hits. | |
maxCategoryTreeDepth | int | Maximum number of categories displayed in the facet from the current refinement. Setting this attribute to N means that no categories will be kept below this level. 0 means no limit. | |
maxCategoryTreeDepthFromRoot | int | Maximum depth of the category tree displayed in the facet from the Top/ level. You can't go further than this limit whatever the refinement level. 0 means no limit. | |
minDocsPerCategory | int | 1 | Minimum number of docs in a category for it to be included in the Refinements panel. |
maxCategories | int | Maximum number of categories to display in the facet. 0 means all categories will be displayed. | |
maxCategoriesPerLevel | int | 100 | Maximum number of facet values in each level of the categories hierarchy. 0 means that all values are selected. The sortFunction is used to select the "best" facet values for each level. |
sortAggregationFunction | string | Aggregation function used to sort by aggregation values. | |
explicitSortOrderValues | string | Ordered list of values used for explicit sort, comma-separated (use the backslash to escape a comma). | |
reverse | boolean | Reverse sorting order. |