SPARQL Results

Formerly Yasr

The viewer began as Yasr. It keeps compatibility with existing Yasr plugins, but its CSS classes has been updated: .yasr* -> .sparql-results*

@rdfjs/sparql-results renders a SPARQL response, as a table, raw response, graph or map. Use it standalone when you have results from anywhere and want SparqlStudio's viewer without the editor.

Wire it to a SparqlEditor instance (or feed it a response from any source):

import SparqlEditor from "@rdfjs/sparql-editor-monaco";
import SparqlResults from "@rdfjs/sparql-results";
import "@rdfjs/sparql-editor-monaco/style.css";
import "@rdfjs/sparql-results/style.css";

const editor = new SparqlEditor(document.getElementById("yasqe")!, {
  requestConfig: { endpoint: "https://sparql.dblp.org/sparql" },
});
const results = new SparqlResults(document.getElementById("sparqlResults")!, {
  // resolve prefixed names in results using the query's PREFIX declarations
  prefixes: () => editor.getPrefixesFromQuery(),
});

// queryResponse is emitted instance-first: (yasqe, response, duration)
editor.on("queryResponse", (editor, response, duration) => {
  results.setResponse(response, duration);
});

Feeding a response directly

You don't need SparqlEditor at all, setResponse accepts any SPARQL JSON / response object:

const results = new SparqlResults(document.getElementById("sparqlResults")!);
results.setResponse(sparqlResultsJson);

Programmatic API

results.setResponse(response, duration);   // parse + render a response
results.selectPlugin("response");          // switch the active plugin by name
results.getSelectedPluginName();           // current plugin name
results.draw();                            // re-render with the current plugin
results.download();                        // download the current view (if supported)
results.somethingDrawn();                  // whether a result is currently rendered
results.results;                           // the parsed response (Parser): getBindings(), getVariables(), getBoolean(), …

Events

Handlers are instance-first: (results, ...payload).

event	payload	fires when
draw	(results, plugin)	just before a plugin renders
drawn	(results, plugin)	after a plugin finishes rendering
change	(results)	the response or settings change

results.on("drawn", (results, plugin) => console.log("rendered with", plugin));

Result-view plugins

Yasr picks a sensible plugin based on the response (a table for SELECT, a boolean for ASK, etc.) and users switch with the tabs above the result area. Built in are Table, Response, Boolean and Error; Graph and Geo are community plugins you register before creating the app:

import GraphPlugin from "@matdata/yasgui-graph-plugin";
import GeoPlugin from "yasgui-geo-tg";

SparqlStudio.Results.registerPlugin("Graph", GraphPlugin);
SparqlStudio.Results.registerPlugin("Geo", GeoPlugin);

See Results plugins for each plugin's config, example queries and how to register your own.