Perspective config schema

Type: object

A schema describing the perspective configuration files.

root id
Type: string

String specifying the perspective id.

root endpoint
Type: object

Object representing the used endpoint's relevant information.

root endpoint url
Type: string

Endpoint URL as string.

root endpoint useAuth
Type: boolean

Boolean determining whether authentication is used when querying the endpoint.

root endpoint prefixesFile
Type: string

The file name of the file containing the prefixes used in SPARQL queries.

root sparqlQueriesFile
Type: string

The file name of the file containing the SPARQL queries as a string.

root baseURIs
Type: object

Object containing different base URIs as properties.

root baseURIs baseURIproperty
Type: object

Base URI property that defines the base URI and the URI template based on that.

root baseURIs baseURIproperty baseURI
Type: string

Base URI as string.

root baseURIs baseURIproperty URITemplate
Type: string

URI template consisting of the base URI and local ID.

root facetClass
Type: string

The URI of the class that is used as the basis for the different facet searches.

root langTag
Type: string

The language code determining which language labels are used.

root frontPageImage
Type: string

File path and name of the image shown on the front page.

root searchMode
Type: enum (of string)

String specifying the search mode.

Must be one of:

  • "federated-search"
  • "faceted-search"
  • "full-text-search"

root defaultActiveFacets
Type: array

Tuple Validation

Item at 1 must be:
root defaultActiveFacets defaultActiveFacets item 0
Type: string

String specifying the names of the default active facets.

root defaultTab
Type: string

String specifying the default tab.

root defaultInstancePageTab
Type: string

String specifying the default instance page tab.

root resultClasses
Type: object

root resultClasses knowledgeGraphMetadata
Type: object

root resultClasses knowledgeGraphMetadata sparqlQuery
Type: enum (of string)

String specifying the type of SPARQL query.

Must be one of:

  • "knowledgeGraphMetadataQuery"

root resultClasses knowledgeGraphMetadata resultMapper
Type: enum (of string)

String specifying how results are mapped.

Must be one of:

  • "makeObjectList"
  • "mapPlaces"
  • "mapLineChart"
  • "mapMultipleLineChart"

Each additional property must conform to the following schema

root resultClasses additionalProperties

The object describing the perspective itself that should be renamed to the perspective name.

root resultClasses additionalProperties anyOf item 0
Type: object

The following properties are required:

  • paginatedResultsConfig
root resultClasses additionalProperties anyOf item 1
Type: object

The following properties are required:

  • tabID
  • tabPath
  • tabIcon
root resultClasses additionalProperties anyOf item 2
Type: object

The following properties are required:

  • sparqlQuery
root resultClasses additionalProperties anyOf item 3
Type: object

The following properties are required:

  • propertiesQueryBlock

root resultClasses additionalProperties paginatedResultsConfig
Type: object

Object representing a config used for paginated results.

root resultClasses additionalProperties paginatedResultsConfig tabID
Type: integer

Integer specifying the id for the tab.

root resultClasses additionalProperties paginatedResultsConfig component
Type: enum (of string)

String specifying the component used for visualizing the paginated results.

Must be one of:

  • "ResultTable"
  • "ReactVirtualizedList"
  • "InstancePageTable"
  • "LeafletMap"
  • "Deck"
  • "ApexCharts"
  • "ApexChartsDouble"
  • "Network"
  • "VideoPage"
  • "BarChartRace"
  • "TemporalMap"
  • "WordCloud"
  • "Export"
  • "ExportCSV"

root resultClasses additionalProperties paginatedResultsConfig tabPath
Type: string

String specifying the relative path of the tab from the search path.

root resultClasses additionalProperties paginatedResultsConfig tabIcon
Type: enum (of string)

String specifying what icon should be used on the tab.

Must be one of:

  • "CalendarViewDay"
  • "CloudDownload"
  • "PieChart"
  • "LocationOn"
  • "TripOrigin"
  • "BubbleChart"
  • "AddLocation"
  • "Redo"
  • "ShowChart"
  • "CalendarToday"
  • "Star"
  • "FormatAlignJustify"
  • "ClearAll"
  • "OndemandVideo"
  • "KeyboardVoice"
  • "Autorenew"
  • "Add"
  • "PlayArrow"
  • "MailOutline"
  • "TrendingDown"
  • "Tune"
  • "ArrowForward"
  • "Subject"

root resultClasses additionalProperties paginatedResultsConfig propertiesQueryBlock
Type: string

The name of the relevant query exported in the SPARQL queries file.

root resultClasses additionalProperties paginatedResultsConfig pagesize
Type: integer

The number of results to be included per page.

root resultClasses additionalProperties paginatedResultsConfig sortBy
Type: enum (of null or string)

String specifying whether the results should be sorted alphabetically (sorting by prefLabel) or by number of search results (sorting by instanceCount).

Must be one of:

  • "prefLabel"
  • "instanceCount"
  • null

root resultClasses additionalProperties paginatedResultsConfig sortDirection
Type: enum (of null or string)

String specifying whether the sorting is ascending or descending.

Must be one of:

  • "asc"
  • "desc"
  • null

root resultClasses additionalProperties paginatedResultsConfig paginatedResultsAlwaysExpandRows
Type: boolean

Boolean specifying whether the rows should have their content always expanded by default or not.

root resultClasses additionalProperties paginatedResultsConfig paginatedResultsRowContentMaxHeight
Type: integer

Integer specifying the maximum height for a row's contents.

root resultClasses additionalProperties instanceConfig
Type: object

root resultClasses additionalProperties instanceConfig propertiesQueryBlock
Type: string

The name of the relevant query exported in the SPARQL queries file.

root resultClasses additionalProperties instanceConfig localIDAsURI
Type: boolean

Boolean indicating whether encoded IDs should be used as URIs instead of using URIs based on base URIs and local IDs.

Each additional property must conform to the following schema

root resultClasses additionalProperties instanceConfig additionalProperties
Type: object

Object for an instance page that should be named to reflect what the tab does (e.g. 'instancePageTable' or 'instancePageExport).

root resultClasses additionalProperties instanceConfig additionalProperties tabID
Type: integer

Integer specifying the id for the page.

root resultClasses additionalProperties instanceConfig additionalProperties component
Type: enum (of string)

String specifying the component used for visualizing the instance page table.

Must be one of:

  • "ResultTable"
  • "ReactVirtualizedList"
  • "InstancePageTable"
  • "LeafletMap"
  • "Deck"
  • "ApexCharts"
  • "ApexChartsDouble"
  • "Network"
  • "VideoPage"
  • "BarChartRace"
  • "TemporalMap"
  • "WordCloud"
  • "Export"
  • "ExportCSV"

root resultClasses additionalProperties instanceConfig additionalProperties tabPath
Type: string

String specifying the relative path of the tab from the search path.

root resultClasses additionalProperties instanceConfig additionalProperties tabIcon
Type: enum (of string)

String specifying what icon should be used on the tab.

Must be one of:

  • "CalendarViewDay"
  • "CloudDownload"
  • "PieChart"
  • "LocationOn"
  • "TripOrigin"
  • "BubbleChart"
  • "AddLocation"
  • "Redo"
  • "ShowChart"

root resultClasses additionalProperties tabID
Type: integer

Integer specifying the tab id.

root resultClasses additionalProperties component
Type: enum (of string)

String specifying the component used for visualizing the data.

Must be one of:

  • "ResultTable"
  • "ReactVirtualizedList"
  • "InstancePageTable"
  • "LeafletMap"
  • "Deck"
  • "ApexCharts"
  • "ApexChartsDouble"
  • "Network"
  • "VideoPage"
  • "BarChartRace"
  • "TemporalMap"
  • "WordCloud"
  • "Export"
  • "ExportCSV"

root resultClasses additionalProperties tabPath
Type: string

String specifying the relative path of the tab from the search path.

root resultClasses additionalProperties tabIcon
Type: enum (of string)

String specifying what icon should be used on the tab.

Must be one of:

  • "CalendarViewDay"
  • "CloudDownload"
  • "PieChart"
  • "LocationOn"
  • "TripOrigin"
  • "BubbleChart"
  • "AddLocation"
  • "Redo"
  • "ShowChart"

root resultClasses additionalProperties resultClass
Type: string

String specifying the result class.

root resultClasses additionalProperties facetClass
Type: string

String specifying the facet class.

root resultClasses additionalProperties sparqlQuery
Type: string

String specifying the SPARQL query.

root resultClasses additionalProperties resultMapper
Type: enum (of string)

String specifying how results are mapped.

Must be one of:

  • "makeObjectList"
  • "mapPlaces"
  • "mapLineChart"
  • "mapMultipleLineChart"

root resultClasses additionalProperties propertiesQueryBlock
Type: string

The name of the relevant query exported in the SPARQL queries file.

root properties
Type: array

Tuple Validation

Item at 1 must be:
root properties properties item 0
Type: object

root properties properties item 0 id
Type: string

The id of the property.

root properties properties item 0 valueType
Type: enum (of string)

String specifying the type of the property values.

Must be one of:

  • "object"
  • "string"
  • "image"

root properties properties item 0 sortValues
Type: boolean

Boolean indicating whether the values should be sorted.

root properties properties item 0 numberedList
Type: boolean

Boolean indicating whether the values should be rendered as a numbered list.

root properties properties item 0 onlyOnInstancePage
Type: boolean

Boolean indicating whether the column should only be shown on instance page or also on results page.

root properties properties item 0 minWidth
Type: integer

Integer specifying what the minimum width of the column for this property is.

root properties properties item 0 disableSort
Type: boolean

Boolean value indicating whether the sort is disabled or not.

root properties properties item 0 hideHeader
Type: boolean

Boolean value indicating whether the header should be hidden or not.

root properties properties item 0 pieChartButton
Type: boolean

Boolean value indicating whether a pie chart should be able to be opened from the facet showcasing the data.

root facets
Type: object

Each additional property must conform to the following schema

root facets additionalProperties
Type: object

An object representing a facet property. The name of this object should be the name of the facet.

root facets additionalProperties containerClass
Type: string

String specifying a number (e.g. 'four', 'ten') of items the container class should show when opened.

root facets additionalProperties facetType
Type: enum (of string)

String specifying the type of the facet. If no type is specified, list type is used by default.

Must be one of:

  • "text"
  • "list"
  • "hierarchical"
  • "timespan"
  • "integer"

root facets additionalProperties labelPattern
Type: string

String specifying a custom pattern that is used for getting the facet labels.

root facets additionalProperties facetLabelFilter
Type: string

String specifying a filter to be applied to the facet labels.

root facets additionalProperties facetLabelPredicate
Type: string

String specifying a predicate used for getting the facet labels. If not specified, the default label predicate skos:prefLabel is used.

root facets additionalProperties hideUnknownValue
Type: boolean

Boolean value that determines whether an 'Unknown' label should be shown in the facet for items that do not have any value(s) for the facet.

root facets additionalProperties filterType
Type: enum (of string)

String specifying the type of the filter used.

Must be one of:

  • "uriFilter"
  • "textFilter"
  • "timespanFilter"
  • "dateNoTimespanFilter"
  • "integerFilter"
  • "spatialFilter"
  • "integerFilterRange"
  • "datasetSelector"
  • "clientFSLiteral"

root facets additionalProperties predicate
Type: string

String specifying the predicate for getting the facet values.

root facets additionalProperties searchField
Type: boolean

Boolean specifying whether a search field is shown for the facet values.

root facets additionalProperties sortButton
Type: boolean

Boolean specifying whether a sorting options are shown for the facet.

root facets additionalProperties sortBy
Type: enum (of string)

String specifying whether the results should be sorted alphabetically (sorting by prefLabel) or by number of search results (sorting by instanceCount).

Must be one of:

  • "prefLabel"
  • "instanceCount"

root facets additionalProperties sortByPredicate
Type: string

String specifying the predicate used for getting the values that the sorting is based on

root facets additionalProperties sortByPattern
Type: string

String specifying a custom pattern that is used for sorting the facet labels.

root facets additionalProperties sortDirection
Type: enum (of string)

String specifying whether the sorting is ascending or descending

Must be one of:

  • "asc"
  • "desc"

root facets additionalProperties textQueryProperty
Type: string

String specifying the property that can be text queried.