Improve this doc View source

secoHierarchyFacet
directive in module seco.facetedSearch

Description

A select box facet for hierarchical values.

Usage

as element:
<seco-hierarchy-facet
       options="{Object}">
</seco-hierarchy-facet>

Parameters

ParamTypeDetails
optionsObject

The configuration object with the following structure:

  • facetId - {string} - A friendly id for the facet. Should be unique in the set of facets, and should be usable as a SPARQL variable.
  • predicate - {string} - The predicate or property path that defines the facet values.
  • hierarchy - {string} - The predicate or property path that defines the hierarchy of values.
  • depth - {number} - The maximum depth of the hierarchy. Default is 3.
  • name - {string} - The title of the facet. Will be displayed to end users.
  • [specifier] {string} - Restriction on the values as a SPARQL triple pattern. Helpful if multiple facets need to be generated from the same predicate, or not all values defined by the given predicate should be selectable. ?value is the variable to which the facet selection is bound. For example, if predicate has been defined as <http://purl.org/dc/terms/subject> (subject), and there are different kinds of subjects for the resource, and you want to select people (<http://xmlns.com/foaf/0.1/Person>) only, you would define specifier as '?value a <http://xmlns.com/foaf/0.1/Person> .'.
  • [enabled] {boolean} - Whether or not the facet is enabled by default. If undefined, the facet will be disabled by default.
  • [endpointUrl] {string} - The URL of the SPARQL endpoint. Optional, as it can also be given globally in FacetHandler config.
  • [headers] {Object} - Additional HTTP headers.
  • [preferredLang] - {string|Array} - The language tag that is preferred when getting labels for facet values, in case the value is a resource. The default is 'en'. Can also be a list of languages, in which case the languages are tried in order. If a label is not found in the given languages, a label without a language tag is used. If a label is still not found, the end part of the resource URI is used. Supported label properties are skos:prefLabel, and rdfs:label.
  • [priority] - {number} - Priority for constraint sorting. Undefined by default.