This project is a webcomponent for Knowledge Graphs displaying data starting from a SPARQL endpoint.
The demo shows how we can display the data obtained from the Open Data Hub SPARQL endpoint in three different formats: gallery, map and table.
Live Demo available on our Web Component Store: https://webcomponents.opendatahub.bz.it/webcomponent/567cb2e2-3e5d-421a-bf85-b8ecc500aab9
Include the webcompscript files webcomp-kg.js in your HTML and define the web components like below.
A Web Component <kg-widget> with three visualizations (map, table, and image gallery) is defined.
<body>
<head>
<title>Example Web Components for Knowledge Graphs</title>
<script src="webcomp-kg.js"></script>
</head>
<kg-widget view="map" endpoint='https://sparql.opendatahub.bz.it/sparql' query="PREFIX schema: <http://schema.org/>
PREFIX geo: <http://www.opengis.net/ont/geosparql#>
SELECT ?h ?pos ?posLabel ?posColor
WHERE {
?h a schema:LodgingBusiness ;
geo:hasGeometry/geo:asWKT ?pos ;
schema:name ?posLabel .
FILTER (lang(?posLabel) = 'de')
# Colors
OPTIONAL {
?h a schema:Campground .
BIND('chlorophyll,0.5' AS ?posColor) # Green
}
OPTIONAL {
?h a schema:BedAndBreakfast .
BIND('viridis,0.1' AS ?posColor) # Purple
}
OPTIONAL {
?h a schema:Hotel .
BIND('jet,0.3' AS ?posColor) # Light blue
}
OPTIONAL {
?h a schema:Hostel .
BIND('jet,0.8' AS ?posColor) # Red
}
}
LIMIT 500"
>
</kg-widget>
</body>View
Type: string
Possible values: 'map', 'table', 'gallery'
The SPARQL endpoint
Type: string
The SPARQL query
Type: string
###Special features It is possible to personalize the pointers on the map using colors or custom icons as shown in the example for kg-map.
You can run and test SPARQL queries on the endpoint at the Open Data Hub Knowledge Graph Portal .
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To build the project, the following prerequisites must be met:
- Node 12
For a ready to use Docker environment with all prerequisites already installed and prepared, you can check out the Docker environment section.
Get a copy of the repository:
git clone https://github.com/noi-techpark/webcomp-kg.gitChange directory:
cd webcomp-kg/Download all dependencies:
npm installBuild and start the project:
npm run startThe application will be served and can be accessed at http://localhost:4200.
The linting can be executed with the following command:
npm run lintTo create the distributable files, execute the following command:
npm run buildThen you can see the examples and the webcomponent script at the example directory.
For the project a Docker environment is already prepared and ready to use with all necessary prerequisites.
These Docker containers are the same as used by the continuous integration servers.
Install Docker (with Docker Compose) locally on your machine.
First, install all dependencies:
docker-compose run --rm app /bin/bash -c "npm install"Before start working you have to start the Docker containers:
docker-compose up --build --detach
After finished working you can stop the Docker containers:
docker-compose stop
When the containers are running, you can execute any command inside the environment. Just replace the dots ... in the following example with the command you wish to execute:
docker-compose run --rm app /bin/bash -c "..."Some examples are:
docker-compose run --rm app /bin/bash -c "npm run build"For support, please contact [email protected].
If you'd like to contribute, please follow the following instructions:
-
Fork the repository.
-
Checkout a topic branch from the
developmentbranch. -
Make sure the tests are passing.
-
Create a pull request against the
developmentbranch.
A more detailed description can be found here: https://github.com/noi-techpark/documentation/blob/master/contributors.md.
More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.
The project uses this boilerplate: https://github.com/noi-techpark/webcomp-boilerplate.
The code in this project is licensed under the AGPL 3 license. See the LICENSE.md file for more information.