configFacets.html

---
layout: default
title: Config | Facets
section: configFacets
path: docs/configFacets.html
---

<h1 class="ui dividing header">
Config: Facets
</h1>
<p>
    Facets config are defined per graph to browse the content of a named graph using a faceted browser interface. The 'generic' facet config will be used if no specific config is defined for a graph.
    For facets config, you have to change the following parameters in <a class="ui label" href="https://github.com/ali1k/ld-r/blob/master/configs/facets.sample.js">configs/facets.js</a>:
</p>
<table class="ui celled table">
  <thead>
    <tr>
      <th>Parameter</th>
      <th>Description</th>
      <th>Example value</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td class="positive">list</td>
      <td> List of all properties for which a facet needs to be created.</td>
      <td>['http://www.w3.org/1999/02/22-rdf-syntax-ns#type',
          'http://risis.eu/cordisH2020/vocab/fundingScheme',
          'http://rdf-vocabulary.ddialliance.org/discovery#startDate']</td>
    </tr>
</table>
<div class="ui ignored info message">
  <i class="ui info icon"></i> If you want to use a chain of properties in the faceted browser, use '->' when specifiying the URIs of the properties in your list. For example, 'ex:address->geo:geo'
</div>
<div class="ui ignored info message">
  <i class="ui info icon"></i> If you want to use a chain of properties scattered around multiple graph names, use '[graphURI]' when specifiying the URIs of the properties in your list. For example, 'ex:orcidID->[http://orcid.org]rdfs:label' . If the property initiates from a graph other than the original one, you can use '[]->' operator. For example '[http://anothergraph2323.com]->rdf:label'
</div>
<div class="ui ignored info message">
  <i class="ui info icon"></i> If you want to use a chain of properties scattered around multiple graph names and multiple SPARQL endpoints, use '[endpointURI>>graphURI]' when specifiying the URIs of the properties in your list. For example, 'ex:orcidID->[http://myendpoint.com>>http://orcid.org]rdfs:label'.
</div>
<div class="ui ignored info message">
  <i class="ui info icon"></i>  If you want to employ a linkset as an intermediate graph when defining a facet, it should be in the first property of the chain with source and target properties separated by '||' e.g. [http://linksetGraph.com]ldr:source||ldr:target->[http://targetGraph]->ldr:intenedProperty.
</div>
<p>
    After defining the above list of facets, users can define specific configs for each facet property by using the URI of the property. These configs are similar to normal <a href="/docs/configReactors.html">reactors config</a> and can overwrite them in the faceted browser. Main facets configs are as following:
</p>
<table class="ui celled table">
  <thead>
    <tr>
      <th>Parameter</th>
      <th>Description</th>
      <th>Example value</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td class="warning">objectBrowser</td>
      <td> Specifies which browser component to use to render the values of a facet property.</td>
      <td>['CheckboxItem']</td>
    </tr>
    <tr>
      <td class="warning">objectIViewer</td>
      <td> Specifies which viewer component to use to render the values of a facet property.</td>
      <td>['TwoLetterCountryView']</td>
    </tr>
    <tr>
      <td class="positive">hasLinkedValue</td>
      <td> Will create a link to view each value of the facets property. If you want to link to another dataset than the current one, you should also add 'containerDatasetURI' config here.</td>
      <td>1</td>
    </tr>
    <tr>
      <td class="positive">position</td>
      <td> can be used to render the selected properties based on a given order. </td>
      <td>0</td>
    </tr>
    <tr>
      <td class="positive">category</td>
      <td> can be used to group selected properties in an accordion menu. </td>
      <td>''</td>
    </tr>
    <tr>
      <td class="positive">isHidden</td>
      <td> can be used to hide a selected property. </td>
      <td>0</td>
    </tr>
     <tr>
      <td class="positive">dispayQueries</td>
      <td> shows the generated queries for each facet. </td>
      <td>0</td>
    </tr>
      <tr>
      <td class="positive">allowRangeOfValues</td>
      <td> shows a range component to filter by min and max values. </td>
      <td>0</td>
    </tr>
    </tr>
    <tr>
      <td class="positive">restrictAnalysisToSelected</td>
      <td> in case of multiple value for a property, can be used to restrict the presented value of the selected properties for analysis only to the selected values. This setting might affect the query performance!  </td>
      <td>0</td>
    </tr>
    <tr>
      <td class="positive">pivotDataset</td>
      <td> gets the URI of an existing dataset and then allows users to dive into the facet taking into account the current query constraints. </td>
      <td>0</td>
    </tr>
</table>
<p>
    A sample config is provided at <a href="https://github.com/ali1k/ld-r/blob/master/configs/facets.sample.js"><span class="ui label">configs/facets.sample.js</span></a>. Each component might have its own proprietary configs. You can find the list of proprietary configs for components in <a href="/docs/componentsOthers.html">Components</a> section.
</p>