API Docs for:
Show:

Multigraph Class

Defined in: src/core/multigraph.js:17
Module: core
Parent Module: multigraph

The Multigraph Jermaine model is the root class for the js-multigraph project.

Constructor

Multigraph

()

Defined in src/core/multigraph.js:17

Methods

browserHasCanvasSupport

() private static

Defined in src/core/multigraph.js:181

Determines if the browser supports canvas elements.

createDefaultMessageHandlers

(
  • div
)
Object static

Defined in src/core/multigraph.js:390

Creates default error and warning functions for multigraph.

Parameters:

  • div HTML Element

Returns:

Object:

Object keyed by error and warning which respectively point to the generated default error and warning functions.

createGraph

(
  • options
)
Promise

Defined in src/core/multigraph.js:204

Creates a Multigraph according to specified options. Returns a jQuery promise which interacts with the multigraph through its done function.

Parameters:

  • options Object
    • div String | HTML Element | JQuery Object

      (REQUIRED) The DOM element div into which the multigraph should be placed; this value may be either (a) a string which is taken to be the id attribute of a div in the page, (b) a reference to the div DOM element itself, or (c) a jQuery object corresponding to the div DOM element.

    • mugl URI

      (REQUIRED, unless muglString is present) the URL from which the MUGL file for the Multigraph can be loaded

    • muglString String

      (REQUIRED, unless mugl is present) a string containing the MUGL XML for the graph

    • driver String

      (OPTIONAL) Indicates which graphics driver to use; should be one of the strings "canvas", "raphael", or "auto". The default (which is used if the 'driver' tag is absent) is "auto", which causes Multigraph to check the features of the browser it is running in and choose the most appropriate driver.

    • error Function

      (OPTIONAL) A function for displaying error messages to the user. Multigraph will call this function if and when it encounters an error. The function should receive a single argument which is an instance of the JavaScript Error object. The default is to use Multigraph's own internal mechanism for displaying user messages.

    • warning Function

      (OPTIONAL) A function for displaying warning messages to the user. Multigraph will call this function if and when it needs to display a warning message. The function should receive a single argument which is an instance of the JavaScript Error object. The default is to use Multigraph's own internal mechanism for displaying user messages.

Returns:

Promise:

jQuery promise which provides interaction with the graph through its done function.

initializeGeometry

(
  • width
  • height
  • graphicsContext
)

Defined in src/core/multigraph.js:148

Initializes the Multigraph's geometry by calling the initializeGeometry function of each of its graph children.

Parameters:

  • width Integer

    Width of the multigraph's div.

  • height Integer

    Height of the multigraph's div.

  • graphicsContext Object

registerCommonDataCallback

(
  • callback
)

Defined in src/core/multigraph.js:165

Convience function for registering callback functions for data becoming ready.

Parameters:

  • callback Function

    Callback function to be registered.

window.multigraph.create

(
  • options
)
Promise static

Defined in src/core/multigraph.js:345

window.multigraph.create is an alias for window.multigraph.core.Multigraph.createGraph.

Parameters:

  • options Object
    • div String | HTML Element | JQuery Object

      (REQUIRED) The DOM element div into which the multigraph should be placed; this value may be either (a) a string which is taken to be the id attribute of a div in the page, (b) a reference to the div DOM element itself, or (c) a jQuery object corresponding to the div DOM element.

    • mugl URI

      (REQUIRED) the URL from which the MUGL file for the Multigraph can be loaded

    • driver String

      (OPTIONAL) Indicates which graphics driver to use; should be one of the strings "canvas", "raphael", or "auto". The default (which is used if the 'driver' tag is absent) is "auto", which causes Multigraph to check the features of the browser it is running in and choose the most appropriate driver.

    • error Function

      (OPTIONAL) A function for displaying error messages to the user. Multigraph will call this function if and when it encounters an error. The function should receive a single argument which is an instance of the JavaScrip Error object. The default is to use Multigraph's own internal mechanism for displaying user messages.

    • warning Function

      (OPTIONAL) A function for displaying warning messages to the user. Multigraph will call this function if and when it needs to display a warning message. The function should receive a single argument which is an instance of the JavaScript Error object. The default is to use Multigraph's own internal mechanism for displaying user messages.

Returns:

Promise:

jQuery promise which provides interaction with the graph through its done function.

Properties

ajaxthrottles

Array

Defined in src/core/multigraph.js:55

JavaScript array of ajax throttles; each entry in this array is an object with the following properties: regex : regular expression for matching URLs ajaxthrottle : instance of $.ajaxthrottle

busySpinner

HTML Element

Defined in src/core/multigraph.js:132

The busy spinner

div

HTML Element

Defined in src/core/multigraph.js:37

The div the multigraph is rendered in.

graphs

Graph

Defined in src/core/multigraph.js:26

Jermiane Attr_List of all the graphs in a Multigraph.

mugl

String

Defined in src/core/multigraph.js:46

The url for the mugl file this graph was created from, if any