Documentation

Main YASR constructor. The first argument, the DOM element to which to append YASR, is required. Optional values are a settings object (see the defaults section for more information), and/or the query response you'd like to show directly on initialization (or alternatively, set this via the doc.setResponse function)

Set and draw a SPARQL response. The parameter is either a plain response string, a jQuery response object, or it is an object with the following keys:

• response: string|object (optional): the response string (or SPARQL XML/JSON object of the response)
• contentType: string (optional)
• exception: string (optional): YASR can display SPARQL errors as well

If there are any results already stored in YASR, draw them according to the currently selected visualization plugin

If there are any results already stored in YASR, draw them according to the currently selected visualization plugin

Show a warning message to the user. Input can either be an html string, or a jQuery object

Check whether a result has been drawn

Store persistent settings in local storage (if enabled via persistency setting in configuration)

Load persistent settings from local storage

Fires just before a plugins draws the results

Fires when a plugin finished drawing the results

List of enabled output plugins. The order of these plugins specifies the order of the output buttons as well

key of default plugin

Enable the use of Google Charts output. Google Charts is used in the Pivot plugin, as well as the Google Charts plugin. As Google Charts cannot be packaged fully in YASR, it poses an external dependency. (in case the Google API is not accessible, the Google Charts visualizations are disabled automatically)

Draw the output selector widget

Draw download icon. Enabled HTML5 download functionality of query results, all on the client-side (i.e. without re-executing the query). This allows the user to download results already queried for, such as a CSV when a table is shown, or the original response when the raw response output is selected

Get the used prefixes. Plugins may use this to create more human-readable URIs. Return object should be in the form {"rdf" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#"}

YASR is able to store settings between browser sessions, using LocalStorage (or, if this is not available, regular cookies or session storage). The persistent settings of YASR are prefixed, to avoid collisions with other applications or instances of YASR (running on the same domain). By default, key of the persistent settings are prefixed using the ID of the nearest parent (containing an ID, that is). To disable persistency alltogether, set this value to false.

Make the query results persistent (set to null or false to disable)

The result set might too large to fit in local storage. It is impossible to detect the free space in the client-side storage. Therefore, we do not store all results in local storage, depending on a max number of characters in the SPARQL result serialization. Set this function conservatively. (especially when using multiple YASR instances on one page)

Defaults for table plugin

Try to fetch the label representation for each URI, using the preflabel.org services. (fetching occurs when hovering over the cell)

Merge bindings together, by using one value as the label, and the other as the hyperlink. When setting this to true, every projection variable ending with 'Label' will be used as text for the corresponding projection variable without that label. I.e., ?carLabel is used as text for the ?car projection variable (as long as ?car is a URI). If you'd like to specify your own postfix to trigger this behaviour, set your postfix as value, instead true.

Draw the cell content, for a given binding

Return the columns you'd like to draw. The output array should be in a format supports by DataTables (for more info see this)

Set a number of handlers for the table

Mouse-enter-cell event. Params that are passed to this function are td: domElement, event: event

Mouse-leave-cell event. Params that are passed to this function are td: domElement, event: event

Cell clicked event. Params that are passed to this function are td: domElement, event: event

Any additional DataTables-related settings. See the DataTables manual for more information

Constructor of plugin which the query response as-is (highlighted using CodeMirror)

Settings object

Any additional CodeMirror related settings. See the CodeMirror manual for more information.

Constructor of plugin

Settings object

Any additional PivotTable related settings. See the PivotTable manual for more information.

Enable the use of google charts for visualizing the pivot data

Enable the use of D3Js for visualizing the pivot data. At this moment, the TreeMap is the only visualization for which the D3 library is used

Merge bindings together, by using one value as the label. When setting this to true, every projection variable ending with 'Label' will be used as text for the corresponding projection variable without that label. I.e., ?carLabel is used as text for the ?car projection variable (as long as ?car is a URI). If you'd like to specify your own postfix to trigger this behaviour, set your postfix as value, instead of true.

Constructor of plugin

Settings object

Constructor of plugin which displays boolean info (i.e., the result of ASK queries)

Constructor of plugin which displays query response errors

Settings object

The message to show when no response was returned. I.e., a DNS or TCP error. Depending on how you use YASR, there might be several reasons for this missing response, such as a CORS-disabled endpoint, the user being offline (where the endpoint is online), an endpoint under maintenance, or simply a wrong URL.

Set this function to present the user with a button to try the same query via a regular browser window. This function simply returns the http link to open the browser window for.

The constructor should return an object with the following keys:

Draw the results. Use the yasr object to retrieve the SPARQL response

Return whether this plugin is able to draw the current results

The priority of a plugin is used to select the output plugin when the currently selected plugin is not able to draw the results.

Whether to show this plugin in the output selector.

The human-readable name of the plugin, shown in the output selector.

Enables the download button. Returns a an object with the keys getContent: function() → response: string, filename: string, contentType: string, buttonTitle: string (the title attribute of the download button). Returning null will disable the download button for the current result.

Enables the embed button. Function should return an html string usable to embed the current output in other web pages. Returning null will disable the embed button for the current result.

If persistency is enabled, use this function to return those settings that you'd like to be persistent. Use to yasr.store() function to actually save these settings

If persistency is enabled, use this function to modify the plugin based on its previous state.