Class Index | File Index

Elements

Classes


Class JXG.JSXGraph


      ↳ JXG.JSXGraph

The JXG.JSXGraph singleton stores all properties required to load, save, create and free a board.

Defined in: jsxgraph.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new JSXGraph singleton object.
Field Summary
Field Attributes Field Name and Description
<static>  
JXG.JSXGraph.rendererType
Stores the renderer that is used to draw the boards.
Method Summary
Method Attributes Method Name and Description
<static>  
JXG.JSXGraph.freeBoard(board)
Delete a board and all its contents.
<static>  
JXG.JSXGraph.initBoard(box, attributes)
Initialise a new board.
<static>  
JXG.JSXGraph.loadBoardFromFile(box, file, format, attributes, callback)
Load a board from a file containing a construction made with either GEONExT, Intergeo, Geogebra, or Cinderella.
<static>  
JXG.JSXGraph.loadBoardFromString(box, string, format, attributes, callback)
Load a board from a base64 encoded string containing a construction made with either GEONExT, Intergeo, Geogebra, or Cinderella.
<static> <deprecated>  
JXG.JSXGraph.registerElement(element, creator)
<static>  
JXG.JSXGraph.unregisterElement(element)
Class Detail
JXG.JSXGraph()
Constructs a new JSXGraph singleton object.
Field Detail
<static> {String} JXG.JSXGraph.rendererType
Stores the renderer that is used to draw the boards.
Method Detail
<static> JXG.JSXGraph.freeBoard(board)
Delete a board and all its contents.
Parameters:
{JXG.Board|String} board
HTML-ID to the DOM-element in which the board is drawn.

<static> {JXG.Board} JXG.JSXGraph.initBoard(box, attributes)
Initialise a new board.
Parameters:
{String} box
Html-ID to the Html-element in which the board is painted.
{Object} attributes
An object that sets some of the board properties. Most of these properties can be set via JXG.Options. Valid properties are
  • boundingbox: An array containing four numbers describing the left, top, right and bottom boundary of the board in user coordinates
  • keepaspectratio: If true, the bounding box is adjusted to the same aspect ratio as the aspect ratio of the div containing the board.
  • showCopyright: Show the copyright string in the top left corner.
  • showNavigation: Show the navigation buttons in the bottom right corner.
  • zoom: Allow the user to zoom with the mouse wheel or the two-fingers-zoom gesture.
  • pan: Allow the user to pan with shift+drag mouse or two-fingers-pan gesture.
  • axis: If set to true, show the axis. Can also be set to an object that is given to both axes as an attribute object.
  • grid: If set to true, shows the grid. Can also bet set to an object that is given to the grid as its attribute object.
  • registerEvents: Register mouse / touch events.
Returns:
{JXG.Board} Reference to the created board.

<static> {JXG.Board} JXG.JSXGraph.loadBoardFromFile(box, file, format, attributes, callback)
Load a board from a file containing a construction made with either GEONExT, Intergeo, Geogebra, or Cinderella.
Parameters:
{String} box
HTML-ID to the HTML-element in which the board is painted.
{String} file
base64 encoded string.
{String} format
containing the file format: 'Geonext' or 'Intergeo'.
{Object} attributes Optional
callback
Returns:
{JXG.Board} Reference to the created board.
See:
JXG.FileReader
JXG.GeonextReader
JXG.GeogebraReader
JXG.IntergeoReader
JXG.CinderellaReader

<static> {JXG.Board} JXG.JSXGraph.loadBoardFromString(box, string, format, attributes, callback)
Load a board from a base64 encoded string containing a construction made with either GEONExT, Intergeo, Geogebra, or Cinderella.
Parameters:
{String} box
HTML-ID to the HTML-element in which the board is painted.
{String} string
base64 encoded string.
{String} format
containing the file format: 'Geonext' or 'Intergeo'.
{Object} attributes Optional
callback
Returns:
{JXG.Board} Reference to the created board.
See:
JXG.FileReader
JXG.GeonextReader
JXG.GeogebraReader
JXG.IntergeoReader
JXG.CinderellaReader

<static> JXG.JSXGraph.registerElement(element, creator)
Parameters:
element
creator
Deprecated:
Use JXG#registerElement

<static> JXG.JSXGraph.unregisterElement(element)
Parameters:
element

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 27 2013 11:32:43 GMT+0200 (CEST)