SPARQL Studio API / SparqlUtils / IYasqe

Interface: IYasqe

Defined in: sparql-utils/src/yasqe.ts:184

The editor-agnostic Yasqe contract that SparqlStudio programs against. Both editor implementations satisfy it (they have many more members; this is only the subset SparqlStudio relies on).

Properties

rootEl

rootEl: HTMLElement

Defined in: sparql-utils/src/yasqe.ts:186

The editor's root element.

---

config

config: object

Defined in: sparql-utils/src/yasqe.ts:191

The resolved editor configuration. SparqlStudio reads/overwrites requestConfig, createShareableLink and editorHeight on the shared instance per tab.

Index Signature

[key: string]: any

requestConfig

requestConfig: RequestConfig<any> | ((yasqe) => RequestConfig<any>)

createShareableLink

createShareableLink: (yasqe) => string

Parameters

yasqe

any

Returns

string

editorHeight

editorHeight: string

Methods

getValue()

getValue(): string

Defined in: sparql-utils/src/yasqe.ts:198

Returns

string

---

setValue()

setValue(value): void

Defined in: sparql-utils/src/yasqe.ts:199

Parameters

value

string

Returns

void

---

setSize()

setSize(height?, width?): void

Defined in: sparql-utils/src/yasqe.ts:200

Parameters

height?

string

width?

string

Returns

void

---

refresh()

refresh(): void

Defined in: sparql-utils/src/yasqe.ts:201

Returns

void

---

focus()

focus(): void

Defined in: sparql-utils/src/yasqe.ts:202

Returns

void

---

query()

query(config?): Promise<any>

Defined in: sparql-utils/src/yasqe.ts:204

Parameters

config?

any

Returns

Promise<any>

---

abortQuery()

abortQuery(): void

Defined in: sparql-utils/src/yasqe.ts:205

Returns

void

---

getUrlArguments()

getUrlArguments(requestConfig): RequestArgs

Defined in: sparql-utils/src/yasqe.ts:207

Build the request arguments for the current query against the given request config.

Parameters

requestConfig

any

Returns

RequestArgs

---

getPrefixesFromQuery()

getPrefixesFromQuery(): object

Defined in: sparql-utils/src/yasqe.ts:209

Returns

object

---

getQueryType()

getQueryType(): QueryType | undefined

Defined in: sparql-utils/src/yasqe.ts:210

Returns

QueryType | undefined

---

getQueryMode()

getQueryMode(): "update" | "query"

Defined in: sparql-utils/src/yasqe.ts:211

Returns

"update" | "query"

---

on()

on(eventName, handler): any

Defined in: sparql-utils/src/yasqe.ts:213

Parameters

eventName

string

handler

(...args) => void

Returns

any

---

off()

off(eventName, handler): any

Defined in: sparql-utils/src/yasqe.ts:214

Parameters

eventName

string

handler

(...args) => void

Returns

any

---

emit()

emit(eventName, ...args): boolean

Defined in: sparql-utils/src/yasqe.ts:215

Parameters

eventName

string | symbol

args

...any[]

Returns

boolean

---

setTheme()?

optional setTheme(theme): void | Promise<void>

Defined in: sparql-utils/src/yasqe.ts:218

Switch the editor theme. Optional: not every editor exposes runtime theme switching.

Parameters

theme

"light" | "dark"

Returns

void | Promise<void>

---

destroy()?

optional destroy(): void

Defined in: sparql-utils/src/yasqe.ts:219

Returns

void

---

getLanguageServers()?

optional getLanguageServers(): LanguageServerInfo[]

Defined in: sparql-utils/src/yasqe.ts:227

Multiple language servers (optional). When two or more are configured the editor shows a switcher; SparqlStudio programs against these to remember the choice per endpoint. Editors emit a languageServerChange event with (instance, { label, description }, index) when the active server changes (whether by the user or programmatically)

Returns

LanguageServerInfo[]

---

getActiveLanguageServer()?

optional getActiveLanguageServer(): number

Defined in: sparql-utils/src/yasqe.ts:229

Index of the active language server, or -1 when none is configured/active.

Returns

number

---

setLanguageServer()?

optional setLanguageServer(labelOrIndex): void | Promise<void>

Defined in: sparql-utils/src/yasqe.ts:231

Activate a language server by label or index. Resolves once it is started and active.

Parameters

labelOrIndex

string | number

Returns

void | Promise<void>

---

getLanguageClient()?

optional getLanguageClient(): any

Defined in: sparql-utils/src/yasqe.ts:233

The active language client (editor-specific type), or undefined when no server is active.

Returns

any

---

notifyEndpointChange()?

optional notifyEndpointChange(endpoint): void

Defined in: sparql-utils/src/yasqe.ts:235

Fire the active language server's onEndpointChange hook (if any) with the new endpoint.

Parameters

endpoint

string

Returns

void