Documentation

Main YASQE constructor. Pass a DOM element as argument to append the editor to, and (optionally) pass along config settings (see the YASQE.defaults object below, as well as the regular CodeMirror documentation, for more information on configurability)

Initialize YASQE from an existing text area (see CodeMirror for more info)

Set query value in editor (see also)

Get query value from editor (see also)

Execute query. Pass a callback function, or a configuration object (see the sparql settings in the configuration object for possible values) I.e., you can change the query configuration by either changing the default settings, changing the settings of this document, or by passing query settings to this function

Fetch the query mode: 'query' or 'update'

Fetch the query type (e.g. SELECT, ASK, DESCRIBE, CONSTRUCT etc)

Fetch defined prefixes from query string

Add prefixes to the query. The prefixes are defined as {"rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"}

Remove prefixes from query. The prefixes are defined as {"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"}

Set size. Use null value to leave width or height unchanged. To resize the editor to fit its content, see http://codemirror.net/demo/resize.html

Enable an autocompleter with this name. Only makes sense if you've programatically disabled this completer before, as a plugin is automatically enabled when registering it (see this function)

Disable an autocompleter with this name.

Store bulk completions in memory as trie, and in localstorage as well (if enabled). The argument should be a key from the autocompletion settings

Hide or show gray backdrop

Collapsing prefixes if there are any. Use false to expand them.

Register an autocompleter in YASQE. This automatically enables the completer as well

Consume the share link, by parsing the document URL for possible yasqe arguments, and setting the appropriate values in the YASQE doc

Create a share link

Determine unique ID of the YASQE object. Useful when several objects are loaded on the same page, and all have 'persistency' enabled. Currently, the ID is determined by selecting the nearest parent in the DOM with an ID set

Fetch property and class autocompletions the Linked Open Vocabulary services. Issues an async autocompletion call

Fetch prefixes from prefix.cc, and store in the YASQE object

Get accept header for this particular query. Get JSON for regular queries, and text/plain for update queries

Fetch all the used variables names from this query

When typing a query, this query is sometimes syntactically invalid, causing the current tokens to be incorrect This causes problem for autocompletion. http://bla might result in two tokens: http:// and bla. We'll want to combine these

Hide completion notification

Show notification

Query string

The list of enabled autocompletion plugins (See this section on how to write your own)

Whether to validate the SPARQL syntax

Collapse prefixes on page load

Enable a gray backdrop on the YASQE instance when a query is being executed. Setting the value to an integer will influence the 'hide' and 'show' animation of the backdrop (set to zero to disable animation)

Extra shortcut keys. Check the CodeMirror manual on how to add your own

Note: To avoid colissions with other browser shortcuts, these shortcuts only work when the YASQE editor is selected (has 'focus').
The list of shortcuts provided by YASQE:

• [Ctrl|Cmd]-Space: Trigger Autocompletion
• [Ctrl|Cmd]-D and [Ctrl|Cmd]-D: Delete current/selected line(s)
• [Ctrl|Cmd]-/: Comment or uncomment current/selected line(s)
• [Ctrl|Cmd]-Alt-Down: Copy line down
• [Ctrl|Cmd]-Alt-Up: Copy line up
• [Ctrl|Cmd]-Shift-F: Auto-format/indent selected lines
• [Ctrl|Cmd]-]: Indent current/selected line(s) more
• [Ctrl|Cmd]-[: Indent current/selected line(s) less
• [Ctrl|Cmd]-S: Save current query in local storage
• [Ctrl|Cmd]-Enter: Execute Query
• F11: Set query editor full-screen (or leave full-screen)
• Esc: Leave full-screen

Show a button with which users can create a link to this query. Set this value to null to disable this functionality. By default, this feature is enabled, and only the query value is appended to the link. This function should return an object which is parseable by jQuery.param

Allow users to create a short-link, for the URL generated in the previous function. The callback takes as argument a possible error string, and the shortened URL

The callback for consuming the arguments of the current URL

Change persistency settings for the YASQE query value. Setting the values to null, will disable persistancy: nothing is stored between browser sessions. Setting the values to a string (or a function which returns a string), will store the query in localstorage using the specified string. By default, the ID is dynamically generated using the YASQE.determineId function, to avoid collissions when using multiple YASQE instances on one page

Settings for querying sparql endpoints

Show a query button. You don't like it? Then disable this setting, and create your button which calls the query() function of the yasqe document

Endpoint to query

Request method via which to access the SPARQL endpoint

Accept header for regular SELECT queries

Accept header for queries returning a graph (e.g. CONSTRUCT)

Accept header for update queries

Named graphs to query.

Default graphs to query.

Additional request arguments. Add them in the form: {name: "name", value: "value"}

Additional request headers

Modify the query before it is send via ajax request.

Set of ajax callbacks

See jQuery.ajax for more information

See jQuery.ajax for more information

See jQuery.ajax for more information

See jQuery.ajax for more information

Autocompleter constructor, which should return the object described below

Get the autocompletions. Either a function which returns an array, or an actual array. The array should be in the form ["<completionsString1>", "<completionsString2>"].

If used as a function, the parameters it receives are

1. token: object If 'bulk' loading is disabled, use this token to return the appropriate list of suggestions for
2. callback: function If 'async' is enabled, return the suggestions by passing it on to this callback

Check whether the cursor is in a proper position for this autocompletion.

Preprocesses the codemirror token before matching it with the autocompletions list. Use this for e.g. autocompleting prefixed resources when your autocompletion list contains only full-length URIs E.g., foaf:name -> http://xmlns.com/foaf/0.1/name

Postprocesses the autocompletion suggestion. Use this for e.g. returning a prefixed URI based on a full-length URI suggestion E.g., http://xmlns.com/foaf/0.1/name -> foaf:name

Specifies that the get function is asynchronous

Use bulk loading of completions: all completions are retrieved onLoad using the get() function. Alternatively, disable bulk loading, to call the get() function whenever a token needs autocompletion (in which case the completion token is passed on to the get() function). whenever you have an autocompletion list that is static, and that easily fits in memory, we advice you to enable bulk for performance reasons (especially because the autocompletions are stored in a trie)

Auto-show the autocompletion dialog. Disabling this requires the user to press [ctrl|cmd]-space to summon the dialog. Note: this only works when completions are not fetched asynchronously

Automatically store autocompletions in localstorage. This is particularly useful when the get() function is an expensive ajax call. Autocompletions are stored for a period of a month. Set this property to null to disable persistency. Otherwise, set a string value (or a function returning a string val), returning the key in which to store the data. Note: this feature only works when completions are loaded in memory (i.e. bulk: true)

A set of callbacks. Most, taken from the CodeMirror showhint plugin

Fires when a codemirror change occurs in a position where we can show this particular type of autocompletion

Fires when a codemirror change occurs in a position where we can not show this particular type of autocompletion

See CodeMirror manual

See CodeMirror manual

See CodeMirror manual

See CodeMirror manual