API Docs for: 0.6.0
Show:

sgvizler Class

Defined in: src/end.js.part:16

The sgvizler javascript reveals properties (attributes) and methods (functions) through the what in this documentation is known as the class sgvizler. This is also why there is both a module and a class called sgvizler. The other class which offers a public API is the sgvizler.Query class. All other classes in the documentation are private.

Members which internally are "public", i.e., available to other classes within the sgvizler package, are marked @protected. Members which are only available within its class are marked @private.

Methods

chartsAdd

(
  • module
  • name
  • draw
  • dependencies
)
Object public

Defined in src/charts.js:27

Available since 0.6.0

Create new Chart type.

Parameters:

  • module String

    The module/namespace name to which the function belongs.

  • name String

    The name of the function.

  • draw Function

    The function which will be the draw() function of the new chart type.

  • dependencies Object

    The list of dependencies for the chart type: function name -- google package/javascript URL pairs.

Returns:

Object:

The chart type.

containerDraw

(
  • elementID
)
public

Defined in src/container.js:191

Available since 0.6.0

Draws the sgvizler-containers with the given element id.

Parameters:

containerDrawAll

() public

Defined in src/container.js:213

Available since 0.3

Draws all sgvizler-containers on page.

datatablesAdd

(
  • module
  • name
  • func
  • dependencies
)
Function public

Defined in src/datatables.js:17

Available since 0.6.0

Create new Chart type.

Parameters:

  • module String

    The module/namespace name to which the function belongs.

  • name String

    The name of the function.

  • func Function

    The datatable processing function.

  • dependencies Object

    The list of dependencies for the chart type: function name -- google package/javascript URL pairs.

Returns:

Function:

The datatable processing function.

defaultBaseURL

() String public

Defined in src/end.js.part:90

Available since 0.6.0

Get Base URL.

Returns:

String:

Returns an empty string if base URL is not set.

defaultBaseURL

(
  • url
)
public chainable

Defined in src/end.js.part:97

Available since 0.6.0

Set Base URL.

Parameters:

defaultChartFunction

(
  • functionName
)
public chainable

Defined in src/end.js.part:277

Available since 0.6.0

Set the name of the default chart function. The function should be availble in the global object, or registered with dependencies in Sgvizler's registry; see sgvizler.chartsAdd()

Parameters:

defaultChartFunction

() String public

Defined in src/end.js.part:270

Available since 0.6.0

Get the name of the default chart function.

Returns:

String:

defaultChartHeight

(
  • height
)
public chainable

Defined in src/end.js.part:299

Available since 0.6.0

Set the default height of chart containers.

Parameters:

defaultChartHeight

() String public

Defined in src/end.js.part:292

Available since 0.6.0

Get the default height of chart containers.

Returns:

String:

defaultChartSpecificOption

() public chainable

Defined in src/end.js.part:330

Available since 0.6.0

TODO

defaultChartWidth

() String public

Defined in src/end.js.part:311

Available since 0.6.0

Get the default width of chart containers.

Returns:

String:

defaultChartWidth

(
  • width
)
public chainable

Defined in src/end.js.part:318

Available since 0.6.0

Set the default width of chart containers.

Parameters:

defaultDatatableFunction

(
  • functionName
)
public chainable

Defined in src/end.js.part:255

Available since 0.6.0

Set the name of the default datatable preprocessing function. The function should be available in the global object, or registered with dependencies in Sgvizler's registry; see sgvizler.datatablesAdd()

Parameters:

defaultDatatableFunction

() String public

Defined in src/end.js.part:247

Available since 0.6.0

Get the name of the default datatable preprocessing function.

Returns:

String:

defaultEndpointOutputFormat

(
  • format
)
public chainable

Defined in src/end.js.part:184

Available since 0.6.0

Set default endpoint output format. Legal values are 'xml', 'json', 'jsonp'.

Parameters:

defaultEndpointOutputFormat

() String public

Defined in src/end.js.part:177

Available since 0.6.0

Get default endpoint output format.

Returns:

String:

defaultEndpointURL

(
  • endpointURL
)
public chainable

Defined in src/end.js.part:162

Available since 0.6.0

Set default endpoint URL.

Parameters:

Example:

sgvizler.defaultEndpointURL('http://sparql.dbpedia.org');

sets the default endpoint to DBpedia's.

defaultEndpointURL

() String public

Defined in src/end.js.part:155

Available since 0.6.0

Get default endpoint URL.

Returns:

String:

defaultFroms

(
  • froms
)
public chainable

Defined in src/end.js.part:139

Available since 0.6.0

Set default list of FROMs to be included in SPARQL query.

Parameters:

  • froms Array

    An array of strings.

defaultFroms

() Array public chainable

Defined in src/end.js.part:131

Available since 0.6.0

Get default list of FROMs set to be included in SPARQL query.

Returns:

Array:

An array of strings.

defaultLoglevel

()

Defined in src/end.js.part:228

These are the java ones, taken from the javadocs:

Permissible values are:

  • SEVERE (highest value)
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST (lowest value)

defaultQuery

(
  • queryString
)
public chainable

Defined in src/end.js.part:119

Available since 0.6.0

Set default query string.

Parameters:

defaultQuery

() String public

Defined in src/end.js.part:112

Available since 0.6.0

Get default query string.

Returns:

String:

defaultValidatorURL

(
  • url
)
public chainable

Defined in src/end.js.part:208

Available since 0.6.0

Set URL to online SPARQL query validator. Appending a SPARQL query to the end of this URL should give a page which validates the given query.

Parameters:

defaultValidatorURL

() String public

Defined in src/end.js.part:201

Available since 0.6.0

Get URL to online SPARQL query validator.

Returns:

String:

formDraw

(
  • [elementID=body]
)
public

Defined in src/form.js:539

Available since 0.1

Main method. Draws the form, gets possible URL parameters, populates form with data, and, if requested, sends a query and draws the chart in the chart container.

Parameters:

  • [elementID=body] String optional

formReset

() public

Defined in src/form.js:514

Available since 0.1

"Button method" used to clear the form and load default values. Does this by simply reloading the page without any URL parameters.

formSubmit

() public

Defined in src/form.js:527

Available since 0.1

"Button method" used to submit the form.

prefix

(
  • prefix
  • namespace
)
public chainable

Defined in src/end.js.part:74

Available since 0.6.0

Set the prefix for a namespace.

Parameters:

prefix

(
  • prefix
)
String public

Defined in src/end.js.part:66

Available since 0.6.0

Get the namespace for a prefix.

Parameters:

Returns:

String:

The namespace recorded for the given prefix.

Properties

HOMEPAGE

String public final

Defined in src/core.js:23

Available since 0.6.0

sgvizler's homepage.

VERSION

String public final

Defined in src/core.js:13

Available since 0.6.0

The version number of this sgvizler.