GeoGebra Apps API

This page describes the GeoGebra Apps API to interact with GeoGebra apps. Please see GeoGebra Apps Embedding on how to embed our apps into your web pages.

Examples

In these examples you can see the GeoGebra Apps API in action:

Arguments in square brackets can be omitted.

Commands and Undo-Points

Method Signature Since Description

Method Signature	Since	Description
boolean evalCommand(String cmdString)	3.0	Evaluates the given string just like it would be evaluated when entered into GeoGebra’s input bar. Returns whether command evaluation was successful. From GeoGebra 3.2 you can pass multiple commands at once by separating them with \n. Note: you must use English commands names
String evalCommandGetLabels(String cmdString)	5.0	Like evalCommand(), but the return value is a String containing a comma-separated list of the labels of the created objects eg `"A,B,C"`
String evalCommandCAS(String string)	3.2	Passes the string to GeoGebra’s CAS and returns the result as a String.
void setUndoPoint()	3.2	Sets an undo point. Useful if you want the user to be able to undo that action of evalCommand eg if you have made an HTML button to act as a custom tool

boolean evalCommand(String cmdString)

3.0

Evaluates the given string just like it would be evaluated when entered into GeoGebra’s input bar. Returns whether command evaluation was successful. From GeoGebra 3.2 you can pass multiple commands at once by separating them with \n. Note: you must use English commands names

String evalCommandGetLabels(String cmdString)

5.0

Like evalCommand(), but the return value is a String containing a comma-separated list of the labels of the created objects eg "A,B,C"

String evalCommandCAS(String string)

3.2

Passes the string to GeoGebra’s CAS and returns the result as a String.

void setUndoPoint()

3.2

Sets an undo point. Useful if you want the user to be able to undo that action of evalCommand eg if you have made an HTML button to act as a custom tool

Setting the state of objects

General methods

Method Signature Since Description

Method Signature	Since	Description
void deleteObject(String objName)	2.7	Deletes the object with the given name.
void setAuxiliary(geo, true/false)	5.0	Affects or not the status of "auxiliary object" to object geo.
void setValue(String objName, double value)	3.2	Sets the double value of the object with the given name. Note: if the specified object is boolean, use a value of 1 to set it to true and any other value to set it to false. For any other object type, nothing is done.
void setTextValue(String objName, String value)	3.2	Sets the text value of the object with the given name. For any other object type, nothing is done.
void setListValue(String objName, int i, double value)	5.0	Sets the value of the list element at position 'i' to 'value'
void setCoords(String objName, double x, double y)void setCoords(String objName, double x, double y, double z)	3.05.0	Sets the coordinates of the object with the given name. Note: if the specified object is not a point, vector, line or absolutely positioned object (text, button, checkbox, input box) nothing is done.
void setCaption(String objName, String caption)	5.0	Sets the caption of object with given name.
void setColor(String objName, int red, int green, int blue)	2.7	Sets the color of the object with the given name.
void setVisible(String objName, boolean visible)	2.7	Shows or hides the object with the given name in the graphics window.
void setLabelVisible(String objName, boolean visible)	3.0	Shows or hides the label of the object with the given name in the graphics window.
void setLabelStyle(String objName, int style)	3.0	Sets the label style of the object with the given name in the graphics window. Possible label styles are NAME = 0, NAME_VALUE = 1, VALUE = 2 and (from GeoGebra 3.2) CAPTION = 3
void setFixed(String objName, boolean fixed, boolean selectionAllowed)	3.0	Sets the "Fixed" and "Selection Allowed" state of the object with the given name. Note: fixed objects cannot be changed.
void setTrace(String objName, boolean flag)	3.0	Turns the trace of the object with the given name on or off.
boolean renameObject(String oldObjName, String newObjName)	3.2	Renames oldObjName to newObjName. Returns whether the rename was successful
void setLayer(String objName, int layer)	3.2	Sets the layer of the object
void setLayerVisible(int layer, boolean visible)	3.2	Shows or hides the all objects in the given layer
void setLineStyle(String objName, int style)	3.2	Sets the line style for the object (0 to 4)
void setLineThickness(String objName, int thickness)	3.2	sets the thickness of the object (1 to 13, -1 for default)
void setPointStyle(String objName, int style)	3.2	Sets the style of points (-1 default, 0 filled circle, 1 cross, 2 circle, 3 plus, 4 filled diamond, 5 unfilled diamond, 6 triangle (north), 7 triangle (south), 8 triangle (east), 9 triangle (west)) - see SetPointStyle Command for the full list
void setPointSize(String objName, int size)	3.2	Sets the size of a point (from 1 to 9)
void setDisplayStyle(String objName, String style)	5.0	Sets the display style of an object. Style should be one of "parametric", "explicit", "implicit", "specific"
void setFilling(String objName, double filling)	3.2	Sets the filling of an object (from 0 to 1)
String getPNGBase64(double exportScale, boolean transparent, double DPI)	4.0	Returns the active Graphics View as a base64-encoded Stringeg var str = ggbApplet.getPNGBase64(1, true, 72); The DPI setting is slow, set to `undefined` if you don’t need it
void exportSVG(String filename) or void exportSVG(function callback)	HTML5	Renders the active Graphics View as an SVG and either downloads it as the given filename or sends it to the callback function The value is `null` if the active view is 3D `ggbApplet.exportSVG(svg => console.log("data:image/svg+xml;utf8," + encodeURIComponent(svg)));` For Classic 5 compatibility please use `ExportImage("type", "svg", "filename", "foo.svg")` inside materials
void exportPDF(double scale, String filename, String sliderLabel) or void exportPDF(double scale, function callback, String sliderLabel)	HTML5	Renders the active Graphics View as a PDF and either downloads it as the given filename or sends it to the callback function `ggbApplet.exportPDF(1, pdf => console.log(pdf));` For Classic 5 compatibility please use `ExportImage("type", "pdf", "filename", "foo.pdf")` instead
void getScreenshotBase64(function callback)	5.0	Gets the screenshot of the whole applet as PNG and sends it to the callback function as a base64 encoded string. Example: `ggbApplet.getScreenshotBase64(function(url){window.open("data:image/png;base64,"+url);});`For internal use only, may not work in all browsers
boolean writePNGtoFile(String filename, double exportScale, boolean transparent, double DPI)	4.0	Exports the active Graphics View to a .PNG file. The DPI setting is slow, set to `undefined` if you don’t need it eg var success = ggbApplet.writePNGtoFile("myImage.png", 1, false, 72);
boolean isIndependent(String objName)	4.0	checks if objName is independent
boolean isMoveable(String objName)	4.0	checks if objName is is moveable
void showAllObjects()	5.0	Changes bounds of the Graphics View so that all visible objects are on screen.

void deleteObject(String objName)

2.7

Deletes the object with the given name.

void setAuxiliary(geo, true/false)

5.0

Affects or not the status of "auxiliary object" to object geo.

void setValue(String objName, double value)

3.2

Sets the double value of the object with the given name. Note: if the specified object is boolean, use a value of 1 to set it to true and any other value to set it to false. For any other object type, nothing is done.

void setTextValue(String objName, String value)

3.2

Sets the text value of the object with the given name. For any other object type, nothing is done.

void setListValue(String objName, int i, double value)

5.0

Sets the value of the list element at position 'i' to 'value'

void setCoords(String objName, double x, double y)void setCoords(String objName, double x, double y, double z)

3.05.0

Sets the coordinates of the object with the given name. Note: if the specified object is not a point, vector, line or absolutely positioned object (text, button, checkbox, input box) nothing is done.

void setCaption(String objName, String caption)

5.0

Sets the caption of object with given name.

void setColor(String objName, int red, int green, int blue)

2.7

Sets the color of the object with the given name.

void setVisible(String objName, boolean visible)

2.7

Shows or hides the object with the given name in the graphics window.

void setLabelVisible(String objName, boolean visible)

3.0

Shows or hides the label of the object with the given name in the graphics window.

void setLabelStyle(String objName, int style)

3.0

Sets the label style of the object with the given name in the graphics window. Possible label styles are NAME = 0, NAME_VALUE = 1, VALUE = 2 and (from GeoGebra 3.2) CAPTION = 3

void setFixed(String objName, boolean fixed, boolean selectionAllowed)

3.0

Sets the "Fixed" and "Selection Allowed" state of the object with the given name. Note: fixed objects cannot be changed.

void setTrace(String objName, boolean flag)

3.0

Turns the trace of the object with the given name on or off.

boolean renameObject(String oldObjName, String newObjName)

3.2

Renames oldObjName to newObjName. Returns whether the rename was successful

void setLayer(String objName, int layer)

3.2

Sets the layer of the object

void setLayerVisible(int layer, boolean visible)

3.2

Shows or hides the all objects in the given layer

void setLineStyle(String objName, int style)

3.2

Sets the line style for the object (0 to 4)

void setLineThickness(String objName, int thickness)

3.2

sets the thickness of the object (1 to 13, -1 for default)

void setPointStyle(String objName, int style)

3.2

Sets the style of points (-1 default, 0 filled circle, 1 cross, 2 circle, 3 plus, 4 filled diamond, 5 unfilled diamond, 6 triangle (north), 7 triangle (south), 8 triangle (east), 9 triangle (west)) - see SetPointStyle Command for the full list

void setPointSize(String objName, int size)

3.2

Sets the size of a point (from 1 to 9)

void setDisplayStyle(String objName, String style)

5.0

Sets the display style of an object. Style should be one of "parametric", "explicit", "implicit", "specific"

void setFilling(String objName, double filling)

3.2

Sets the filling of an object (from 0 to 1)

String getPNGBase64(double exportScale, boolean transparent, double DPI)

4.0

Returns the active Graphics View as a base64-encoded Stringeg var str = ggbApplet.getPNGBase64(1, true, 72); The DPI setting is slow, set to undefined if you don’t need it

void exportSVG(String filename) or void exportSVG(function callback)

HTML5

Renders the active Graphics View as an SVG and either downloads it as the given filename or sends it to the callback function The value is null if the active view is 3D ggbApplet.exportSVG(svg => console.log("data:image/svg+xml;utf8," + encodeURIComponent(svg))); For Classic 5 compatibility please use ExportImage("type", "svg", "filename", "foo.svg") inside materials

void exportPDF(double scale, String filename, String sliderLabel) or void exportPDF(double scale, function callback, String sliderLabel)

HTML5

Renders the active Graphics View as a PDF and either downloads it as the given filename or sends it to the callback function ggbApplet.exportPDF(1, pdf => console.log(pdf)); For Classic 5 compatibility please use ExportImage("type", "pdf", "filename", "foo.pdf") instead

void getScreenshotBase64(function callback)

5.0

Gets the screenshot of the whole applet as PNG and sends it to the callback function as a base64 encoded string. Example: ggbApplet.getScreenshotBase64(function(url){window.open("data:image/png;base64,"+url);});For internal use only, may not work in all browsers

boolean writePNGtoFile(String filename, double exportScale, boolean transparent, double DPI)

4.0

Exports the active Graphics View to a .PNG file. The DPI setting is slow, set to undefined if you don’t need it eg var success = ggbApplet.writePNGtoFile("myImage.png", 1, false, 72);

boolean isIndependent(String objName)

4.0

checks if objName is independent

boolean isMoveable(String objName)

4.0

checks if objName is is moveable

void showAllObjects()

5.0

Changes bounds of the Graphics View so that all visible objects are on screen.

Automatic Animation

Method Signature	Since	Description
void setAnimating(String objName, boolean animate)	3.2	Sets whether an object should be animated. This does not start the animation yet, use startAnimation() to do so.
void setAnimationSpeed(String objName, double speed)	3.2	Sets the animation speed of an object.
void startAnimation()	3.2	Starts automatic animation for all objects with the animating flag set, see setAnimating()
void stopAnimation()	3.2	Stops animation for all objects with the animating flag set, see setAnimating()
boolean isAnimationRunning()	3.2	Returns whether automatic animation is currently running.

Method Signature

Since

Description

void setAnimating(String objName, boolean animate)

3.2

Sets whether an object should be animated. This does not start the animation yet, use startAnimation() to do so.

void setAnimationSpeed(String objName, double speed)

3.2

Sets the animation speed of an object.

void startAnimation()

3.2

Starts automatic animation for all objects with the animating flag set, see setAnimating()

void stopAnimation()

3.2

Stops animation for all objects with the animating flag set, see setAnimating()

boolean isAnimationRunning()

3.2

Returns whether automatic animation is currently running.

Getting the state of objects

Method Signature Since Description

Method Signature	Since	Description
double getXcoord(String objName)	2.7	Returns the cartesian x-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.
double getYcoord(String objName)	2.7	Returns the cartesian y-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.
double getZcoord(String objName)	5.0	Returns the cartesian z-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.
double getValue(String objName)	3.2	Returns the double value of the object with the given name (e.g. length of segment, area of polygon). Note: returns 1 for a boolean object with value true. Otherwise 0 is returned.
double getListValue(String objName, Integer index)	5.0	Returns the double value of the object in the list (with the given name) with the given index. Note: returns 1 for a boolean object with value true. Otherwise 0 is returned.
String getColor(String objName)	2.7	Returns the color of the object with the given name as a hex string, e.g. "#FF0000" for red. Note that the hex string always starts with # and contains no lower case letters.
boolean getVisible(String objName)	3.2	Returns true or false depending on whether the object is visible in the Graphics View. Returns false if the object does not exist.
boolean getVisible(String objName, int view)	4.2	Returns true or false depending on whether the object is visible in Graphics View 'view' (1 or 2). Returns false if the object does not exist.
String getValueString(String objName [, boolean useLocalizedInput = true])	2.7	Returns the value of the object with the given name as a string. If useLocalizedInput is false, returns the command in English, otherwise in current GUI language. Note: Localized input uses parentheses, non-localized input uses brackets.For this method (and all others returning type String) it’s important to coerce it properly to a JavaScript string for compatibility with GeoGebra Classic 5 eg `var s = getValueString("text1") + "";`
String getDefinitionString(String objName)	2.7	Returns the description of the object with the given name as a string (in the currently selected language)
String getCommandString(String objName [, boolean useLocalizedInput])	5.0	Returns the command of the object with the given name as a string. If useLocalizedInput is false, returns the command in English, otherwise in current GUI language. Note: Localized input uses parentheses, non-localized input uses brackets.
String getLaTeXString(String objName)	5.0	Returns the value of given object in LaTeX syntax
String getLaTeXBase64(String objName, boolean value)	5.0	Returns base64 encoded PNG picture containing the object as LaTeX. For value = false the object is represented as the definition, for value=true the object value is used.
String getObjectType(String objName)	2.7	Returns the type of the given object as a string (like "point", "line", "circle", etc.).
boolean exists(String objName)	2.7	Returns whether an object with the given name exists in the construction.
boolean isDefined(String objName)	2.7	Returns whether the given object’s value is valid at the moment.
String [] getAllObjectNames([String type])	2.7	Returns an array with all object names in the construction. If type parameter is entered, only objects of given type are returned.
int getObjectNumber()	3.0	Returns the number of objects in the construction.
int getCASObjectNumber()	3.0	Returns the number of object (nonempty cells) in CAS.
String getObjectName(int i)	3.0	Returns the name of the n-th object of the construction.
String getLayer(String objName)	3.2	Returns the layer of the object.
int getLineStyle(String objName)	3.2	Gets the line style for the object (0 to 4)
int getLineThickness(String objName)	3.2	Gets the thickness of the line (1 to 13)
int getPointStyle(String objName)	3.2	Gets the style of points (-1 default, 0 filled circle, 1 circle, 2 cross, 3 plus, 4 filled diamond, 5 unfilled diamond, 6 triangle (north), 7 triangle (south), 8 triangle (east), 9 triangle (west))
int getPointSize(String objName)	3.2	Gets the size of a point (from 1 to 9)
double getFilling(String objName)	3.2	Gets the filling of an object (from 0 to 1)
getCaption(String objectName, boolean substitutePlaceholders)	5.0	Returns the caption of the object. If the caption contains placeholders (%n, %v,…), you can use the second parameter to specify whether you want to substitute them or not.
getLabelStyle(String objectName)	5.0	Returns label type for given object, see setLabelStyle for possible values.
getLabelVisible()	5.0
isInteractive(String objName)		Returns true, if the object with label objName is existing and the user can get to this object using TAB.

double getXcoord(String objName)

2.7

Returns the cartesian x-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.

double getYcoord(String objName)

2.7

Returns the cartesian y-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.

double getZcoord(String objName)

5.0

Returns the cartesian z-coord of the object with the given name. Note: returns 0 if the object is not a point or a vector.

double getValue(String objName)

3.2

Returns the double value of the object with the given name (e.g. length of segment, area of polygon). Note: returns 1 for a boolean object with value true. Otherwise 0 is returned.

double getListValue(String objName, Integer index)

5.0

Returns the double value of the object in the list (with the given name) with the given index. Note: returns 1 for a boolean object with value true. Otherwise 0 is returned.

String getColor(String objName)

2.7

Returns the color of the object with the given name as a hex string, e.g. "#FF0000" for red. Note that the hex string always starts with # and contains no lower case letters.

boolean getVisible(String objName)

3.2

Returns true or false depending on whether the object is visible in the Graphics View. Returns false if the object does not exist.

boolean getVisible(String objName, int view)

4.2

Returns true or false depending on whether the object is visible in Graphics View 'view' (1 or 2). Returns false if the object does not exist.

String getValueString(String objName [, boolean useLocalizedInput = true])

2.7

Returns the value of the object with the given name as a string. If useLocalizedInput is false, returns the command in English, otherwise in current GUI language. Note: Localized input uses parentheses, non-localized input uses brackets.For this method (and all others returning type String) it’s important to coerce it properly to a JavaScript string for compatibility with GeoGebra Classic 5 eg var s = getValueString("text1") + "";

String getDefinitionString(String objName)

2.7

Returns the description of the object with the given name as a string (in the currently selected language)

String getCommandString(String objName [, boolean useLocalizedInput])

5.0

Returns the command of the object with the given name as a string. If useLocalizedInput is false, returns the command in English, otherwise in current GUI language. Note: Localized input uses parentheses, non-localized input uses brackets.

String getLaTeXString(String objName)

5.0

Returns the value of given object in LaTeX syntax

String getLaTeXBase64(String objName, boolean value)

5.0

Returns base64 encoded PNG picture containing the object as LaTeX. For value = false the object is represented as the definition, for value=true the object value is used.

String getObjectType(String objName)

2.7

Returns the type of the given object as a string (like "point", "line", "circle", etc.).

boolean exists(String objName)

2.7

Returns whether an object with the given name exists in the construction.

boolean isDefined(String objName)

2.7

Returns whether the given object’s value is valid at the moment.

String [] getAllObjectNames([String type])

2.7

Returns an array with all object names in the construction. If type parameter is entered, only objects of given type are returned.

int getObjectNumber()

3.0

Returns the number of objects in the construction.

int getCASObjectNumber()

3.0

Returns the number of object (nonempty cells) in CAS.

String getObjectName(int i)

3.0

Returns the name of the n-th object of the construction.

String getLayer(String objName)

3.2

Returns the layer of the object.

int getLineStyle(String objName)

3.2

Gets the line style for the object (0 to 4)

int getLineThickness(String objName)

3.2

Gets the thickness of the line (1 to 13)

int getPointStyle(String objName)

3.2

Gets the style of points (-1 default, 0 filled circle, 1 circle, 2 cross, 3 plus, 4 filled diamond, 5 unfilled diamond, 6 triangle (north), 7 triangle (south), 8 triangle (east), 9 triangle (west))

int getPointSize(String objName)

3.2

Gets the size of a point (from 1 to 9)

double getFilling(String objName)

3.2

Gets the filling of an object (from 0 to 1)

getCaption(String objectName, boolean substitutePlaceholders)

5.0

Returns the caption of the object. If the caption contains placeholders (%n, %v,…), you can use the second parameter to specify whether you want to substitute them or not.

getLabelStyle(String objectName)

5.0

Returns label type for given object, see setLabelStyle for possible values.

getLabelVisible()

5.0

isInteractive(String objName)

Returns true, if the object with label objName is existing and the user can get to this object using TAB.

Construction / User Interface

Method Signature Since Description

Method Signature	Since	Description
void setMode(int mode)	2.7	Sets the mouse mode (i.e. tool) for the graphics window (see toolbar reference and the applet parameters "showToolBar" and "customToolBar" )
int getMode()	5.0	Gets the mouse mode (i.e. tool), see toolbar reference for details
void openFile(String strURL)	2.7 (Java only)	Opens a construction from a file (given as absolute or relative URL string)
void reset()	2.7	Reloads the initial construction (given in filename parameter) of this applet.
void newConstruction()	2.7	Removes all construction objects
void refreshViews()	2.7	Refreshs all views. Note: this clears all traces in the graphics window.
void setOnTheFlyPointCreationActive(boolean flag)	3.2	Turns on the fly creation of points in graphics view on (true) or off (false). Note: this is useful if you don’t want tools to have the side effect of creating points. For example, when this flag is set to false, the tool "line through two points" will not create points on the fly when you click on the background of the graphics view.
void setPointCapture(view, mode)	5.0	Change point capturing mode. view: 1 for graphics, 2 for graphics 2, -1 for 3D. mode: 0 for no capturing, 1 for snap to grid, 2 for fixed to grid, 3 for automatic.
void setRounding(string round)	5.0	The string consists of a number and flags, "s" flag for significant digits, "d" for decimal places (default). JavaScript integers are cast to string automaticlly. Example: "10s", "5", 3
void hideCursorWhenDragging(boolean flag)	3.2	Hides (true) or shows (false) the mouse cursor (pointer) when dragging an object to change the construction.
void setRepaintingActive(boolean flag)	2.7	Turns the repainting of this applet on (true) or off (false). Note: use this method for efficient repainting when you invoke several methods.
void setErrorDialogsActive(boolean flag)	3.0	Turns showing of error dialogs on (true) or off (false). Note: this is especially useful together with evalCommand().
void setCoordSystem(double xmin, double xmax, double ymin, double ymax)	3.0	Sets the Cartesian coordinate system of the graphics window.
void setCoordSystem(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax, boolean yVertical)	5.0	Sets the Cartesian coordinate system of the 3D graphics window. The last parameter determines whether y-axis should be oriented vertically.
void setAxesVisible(boolean xAxis, boolean yAxis)	3.0	Shows or hides the x- and y-axis of the coordinate system in the graphics windows 1 and 2.
void setAxesVisible(int viewNumber, boolean xAxis, boolean yAxis, boolean zAxis)	5.0	Shows or hides the x-, y- and z-axis of the coordinate system in given graphics window. `ggbApplet.setAxesVisible(3, false, true, true)`
void setAxisLabels(int viewNumber, String xAxis, String yAxis, String zAxis)	5.0	Set label for the x-, y- and z-axis of the coordinate system in given graphics window. `ggbApplet.setAxisLabels(3,"larg","long","area")`
void setAxisSteps(int viewNumber, double xAxis, double yAxis, double zAxis)	5.0	Set distance for the x-, y- and z-axis of the coordinate system in given graphics window. `ggbApplet.setAxisSteps(3, 2,1,0.5)`
void setAxisUnits(int viewNumber, String xAxis, String yAxis, String zAxis)	5.0	Set units for the x-, y- and z-axis of the coordinate system in given graphics window. `ggbApplet.setAxisUnits(3, "cm","cm","cm²")`
void setGridVisible(boolean flag)	3.0	Shows or hides the coordinate grid in the graphics windows 1 and 2.
void setGridVisible(int viewNumber, boolean flag)	5.0	Shows or hides the coordinate grid in given graphics view graphics window.
getGridVisible(int viewNumber)	5.0	Returns true if grid is visible in given view. If view number is omited, returns whether grid is visible in the first graphics view.
getPerspectiveXML()	5.0	Returns an XML representation of the current perspective.
undo()	5.0	Undoes one user action.
redo()	5.0	Redoes one user action.
showToolBar(boolean show)	HTML5	Sets visibility of toolbar
setCustomToolBar(String toolbar)	5.0	Sets the layout of the main toolbar, see toolbar reference for details
showMenuBar(boolean show)	HTML5	Sets visibility of menu bar
showAlgebraInput(boolean show)	HTML5	Sets visibility of input bar
showResetIcon(boolean show)	HTML5	Sets visibility of reset icon
enableRightClick(boolean enable)	5.0	Enables or disables right click features
enableLabelDrags(boolean enable)	5.0	Enables or disables dragging object labels
enableShiftDragZoom(boolean enable)	5.0	Enables or disables zooming and dragging the view using mouse or keyboard
enableCAS(boolean enable)	5.0	Enables or disables CAS features (both the view and commands)
enable3D(boolean enable)	5.0	Enables or disables the 3D view
void setPerspective(string perspective)	5.0	Changes the open views, see SetPerspective Command for the string interpretation.
setWidth(int width)	5.0 (HTML5)	Change width of the applet (in pixels)
setHeight(int height)	5.0 (HTML5)	Change height of the applet (in pixels)
setSize(int width, int height)	5.0 (HTML5)	Change width and height of the applet (in pixels)
recalculateEnvironments()	5.0 (HTML5)	Update the applet after scaling by external CSS
getEditorState()	5.0 (HTML5)	Get state of the equation editor in algebra view (or in evaluator applet). Returns JSON object with `content` and optional fields (`caret` for graphing app, `eval` and `latex` for evaluator app)
setEditorState(Object state)	5.0 (HTML5)	Set state of the equation editor in algebra view (or in evaluator applet). The argument should be a JSON (object or string) with `content` and optional `caret` field.
getGraphicsOptions(int viewId)	5.0 (HTML5)	Get the graphics options for euclidian view specified by viewId. It returns a JSON (object or string) with `rightAngleStyle`, `pointCapturing`, `grid`, `gridIsBold`, `gridType`, `bgColor`, `gridColor`, `axesColor`, `axes`, `gridDistance`
setGraphicsOptions(int viewId, Object options)	5.0 (HTML5)	Set the graphics options for euclidian view specified by viewId. The second argument should be a JSON (object or string) with optional fields with `rightAngleStyle`, `pointCapturing`, `grid`, `gridIsBold`, `gridType`, `bgColor`, `gridColor`, `axesColor`, `axes`, `gridDistance`
setAlgebraOptions(Object options)	5.0 (HTML5)	Set the options for the algebra view. The argument should be a JSON (object or string) with field `sortBy`

void setMode(int mode)

2.7

Sets the mouse mode (i.e. tool) for the graphics window (see toolbar reference and the applet parameters "showToolBar" and "customToolBar" )

int getMode()

5.0

Gets the mouse mode (i.e. tool), see toolbar reference for details

void openFile(String strURL)

2.7 (Java only)

Opens a construction from a file (given as absolute or relative URL string)

void reset()

2.7

Reloads the initial construction (given in filename parameter) of this applet.

void newConstruction()

2.7

Removes all construction objects

void refreshViews()

2.7

Refreshs all views. Note: this clears all traces in the graphics window.

void setOnTheFlyPointCreationActive(boolean flag)

3.2

Turns on the fly creation of points in graphics view on (true) or off (false). Note: this is useful if you don’t want tools to have the side effect of creating points. For example, when this flag is set to false, the tool "line through two points" will not create points on the fly when you click on the background of the graphics view.

void setPointCapture(view, mode)

5.0

Change point capturing mode.

view: 1 for graphics, 2 for graphics 2, -1 for 3D.

mode: 0 for no capturing, 1 for snap to grid, 2 for fixed to grid, 3 for automatic.

void setRounding(string round)

5.0

The string consists of a number and flags, "s" flag for significant digits, "d" for decimal places (default). JavaScript integers are cast to string automaticlly. Example: "10s", "5", 3

void hideCursorWhenDragging(boolean flag)

3.2

Hides (true) or shows (false) the mouse cursor (pointer) when dragging an object to change the construction.

void setRepaintingActive(boolean flag)

2.7

Turns the repainting of this applet on (true) or off (false). Note: use this method for efficient repainting when you invoke several methods.

void setErrorDialogsActive(boolean flag)

3.0

Turns showing of error dialogs on (true) or off (false). Note: this is especially useful together with evalCommand().

void setCoordSystem(double xmin, double xmax, double ymin, double ymax)

3.0

Sets the Cartesian coordinate system of the graphics window.

void setCoordSystem(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax, boolean yVertical)

5.0

Sets the Cartesian coordinate system of the 3D graphics window. The last parameter determines whether y-axis should be oriented vertically.

void setAxesVisible(boolean xAxis, boolean yAxis)

3.0

Shows or hides the x- and y-axis of the coordinate system in the graphics windows 1 and 2.

void setAxesVisible(int viewNumber, boolean xAxis, boolean yAxis, boolean zAxis)

5.0

Shows or hides the x-, y- and z-axis of the coordinate system in given graphics window.

ggbApplet.setAxesVisible(3, false, true, true)

void setAxisLabels(int viewNumber, String xAxis, String yAxis, String zAxis)

5.0

Set label for the x-, y- and z-axis of the coordinate system in given graphics window.

ggbApplet.setAxisLabels(3,"larg","long","area")

void setAxisSteps(int viewNumber, double xAxis, double yAxis, double zAxis)

5.0

Set distance for the x-, y- and z-axis of the coordinate system in given graphics window.

ggbApplet.setAxisSteps(3, 2,1,0.5)

void setAxisUnits(int viewNumber, String xAxis, String yAxis, String zAxis)

5.0

Set units for the x-, y- and z-axis of the coordinate system in given graphics window.

ggbApplet.setAxisUnits(3, "cm","cm","cm²")

void setGridVisible(boolean flag)

3.0

Shows or hides the coordinate grid in the graphics windows 1 and 2.

void setGridVisible(int viewNumber, boolean flag)

5.0

Shows or hides the coordinate grid in given graphics view graphics window.

getGridVisible(int viewNumber)

5.0

Returns true if grid is visible in given view. If view number is omited, returns whether grid is visible in the first graphics view.

getPerspectiveXML()

5.0

Returns an XML representation of the current perspective.

undo()

5.0

Undoes one user action.

redo()

5.0

Redoes one user action.

showToolBar(boolean show)

HTML5

Sets visibility of toolbar

setCustomToolBar(String toolbar)

5.0

Sets the layout of the main toolbar, see toolbar reference for details

showMenuBar(boolean show)

HTML5

Sets visibility of menu bar

showAlgebraInput(boolean show)

HTML5

Sets visibility of input bar

showResetIcon(boolean show)

HTML5

Sets visibility of reset icon

enableRightClick(boolean enable)

5.0

Enables or disables right click features

enableLabelDrags(boolean enable)

5.0

Enables or disables dragging object labels

enableShiftDragZoom(boolean enable)

5.0

Enables or disables zooming and dragging the view using mouse or keyboard

enableCAS(boolean enable)

5.0

Enables or disables CAS features (both the view and commands)

enable3D(boolean enable)

5.0

Enables or disables the 3D view

void setPerspective(string perspective)

5.0

Changes the open views, see SetPerspective Command for the string interpretation.

setWidth(int width)

5.0 (HTML5)

Change width of the applet (in pixels)

setHeight(int height)

5.0 (HTML5)

Change height of the applet (in pixels)

setSize(int width, int height)

5.0 (HTML5)

Change width and height of the applet (in pixels)

recalculateEnvironments()

5.0 (HTML5)

Update the applet after scaling by external CSS

getEditorState()

5.0 (HTML5)

Get state of the equation editor in algebra view (or in evaluator applet). Returns JSON object with content and optional fields (caret for graphing app, eval and latex for evaluator app)

setEditorState(Object state)

5.0 (HTML5)

Set state of the equation editor in algebra view (or in evaluator applet). The argument should be a JSON (object or string) with content and optional caret field.

getGraphicsOptions(int viewId)

5.0 (HTML5)

Get the graphics options for euclidian view specified by viewId. It returns a JSON (object or string) with rightAngleStyle, pointCapturing, grid, gridIsBold, gridType, bgColor, gridColor, axesColor, axes, gridDistance

setGraphicsOptions(int viewId, Object options)

5.0 (HTML5)

Set the graphics options for euclidian view specified by viewId. The second argument should be a JSON (object or string) with optional fields with rightAngleStyle, pointCapturing, grid, gridIsBold, gridType, bgColor, gridColor, axesColor, axes, gridDistance

setAlgebraOptions(Object options)

5.0 (HTML5)

Set the options for the algebra view. The argument should be a JSON (object or string) with field sortBy

Event listeners

With these methods you can implement Applet to JavaScript communication. For example, these methods can be used to:

monitor user actions (see Event listeners example)
communicate between two GeoGebra applets (see two applets example)

Method Signature Since Description

Method Signature	Since	Description
void registerAddListener(JSFunction function)	3.0	Registers a JavaScript function as an add listener for the applet’s construction. Whenever a new object is created in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the newly created object as its single argument. Example: First, register a listening JavaScript function: ggbApplet.registerAddListener(myAddListenerFunction); When an object "A" is created, the GeoGebra Applet will call the Javascript function myAddListenerFunction("A");
void unregisterAddListener(JSFunction function)	3.0	Removes a previously registered add listener, see registerAddListener()
void registerRemoveListener(JSFunction function)	3.0	Registers a JavaScript function as a remove listener for the applet’s construction. Whenever an object is deleted from the GeoGebraApplet’s construction, the JavaScript function is called using the name of the deleted object as its single argument. Note: when a construction is cleared, remove is not called for every single object, see registerClearListener(). Example: First, register a listening JavaScript function: ggbApplet.registerRemoveListener(myRemoveListenerFunction); When the object "A" is deleted, the GeoGebra Applet will call the Javascript function myRemoveListenerFunction("A");
void unregisterRemoveListener(JSFunction function)	3.0	Removes a previously registered remove listener, see registerRemoveListener()
void registerUpdateListener(JSFunction function)	3.0	Registers a JavaScript function as a update listener for the applet’s construction. Whenever any object is updated in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the updated object as its single argument. Note: when you only want to listen for the updates of a single object use registerObjectUpdateListener() instead. Example: First, register a listening JavaScript function: ggbApplet.registerUpdateListener(myUpdateListenerFunction); When the object "A" is updated, the GeoGebra Applet will call the Javascript function myUpdateListenerFunction("A");
void unregisterUpdateListener(JSFunction function)	3.0	Removes a previously registered update listener, see registerUpdateListener()
void registerClickListener(JSFunction function)	5.0	Registers a JavaScript function as a click listener for the applet’s construction. Whenever any object is clicked in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the updated object as its single argument. Note: when you only want to listen for the updates of a single object use registerObjectClickListener() instead.
void unregisterClickListener(JSFunction function)	3.0	Removes a previously registered click listener, see registerClickListener()
void registerObjectUpdateListener(String objName, JSFunction function)	3.0	Registers a JavaScript function as an update listener for a single object. Whenever the object with the given name is updated, the JavaScript function is called using the name of the updated object as its single argument. If objName previously had a mapping JavaScript function, the old value is replaced. Note: all object updated listeners are unregistered when their object is removed or the construction is cleared, see registerRemoveListener() and registerClearListener(). Example: First, register a listening JavaScript function: ggbApplet.registerObjectUpdateListener("A", myAupdateListenerFunction); Whenever the object A is updated, the GeoGebra Applet will call the Javascript function myAupdateListenerFunction(); Note: an object update listener will still work after an object is renamed.
void unregisterObjectUpdateListener(String objName)	3.0	Removes a previously registered object update listener of the object with the given name, see registerObjectUpdateListener()
void registerObjectClickListener(String objName, JSFunction function)	5.0	Registers a JavaScript function as a click listener for a single object. Whenever the object with the given name is clicked, the JavaScript function is called using the name of the updated object as its single argument. If objName previously had a mapping JavaScript function, the old value is replaced. Note: all object click listeners are unregistered when their object is removed or the construction is cleared, see registerRemoveListener() and registerClearListener(). Example: First, register a listening JavaScript function: ggbApplet.registerObjectClickListener("A", myAclickListenerFunction); Whenever the object A is clicked, the GeoGebra Applet will call the Javascript function myAclickListenerFunction(); Note: an object click listener will still work after an object is renamed.
void unregisterObjectClickListener(String objName)	5.0	Removes a previously registered object click listener of the object with the given name, see registerObjectClickListener()
void registerRenameListener(JSFunction function)	3.0	Registers a JavaScript function as a rename listener for the applet’s construction. Whenever an object is renamed in the GeoGebraApplet’s construction, the JavaScript function is called using the old name and the new name of the renamed object as its two arguments. Example: First, register a listening JavaScript function: ggbApplet.registerRenameListener(myRenameListenerFunction); When an object "A" is renamed to "B", the GeoGebra Applet will call the Javascript function myRenameListenerFunction("A", "B");
void unregisterRenameListener(String objName)	3.0	Removes a previously registered rename listener, see registerRenameListener()
void registerClearListener(JSFunction function)	3.0	Registers a JavaScript function as a clear listener for the applet’s construction. Whenever the construction in the GeoGebraApplet is cleared (i.e. all objects are removed), the JavaScript function is called using no arguments. Note: all update listeners are unregistered when a construction is cleared. See registerUpdateListener() and registerRemoveListener(). Example: First, register a listening JavaScript function: ggbApplet.registerClearListener(myClearListenerFunction); When the construction is cleared (i.e. after reseting a construction or opening a new construction file), the GeoGebra Applet will call the Javascript function myClearListenerFunction();
void unregisterClearListener(JSFunction function)	3.0	Removes a previously registered clear listener, see registerClearListener()
void registerStoreUndoListener(JSFunction function)	4.4	Registers a listener that is called (with no arguments) every time an undo point is created.
void unregisterStoreUndoListener(JSFunction function)	4.4	Removes previously registered listener for storing undo points, see registerStoreUndoListener
void registerClientListener(JSFunction function)	5.0	Registers a JavaScript function as a generic listener for the applet’s construction. The listener receives events as JSON objects of the form `{type: "setMode", target:"", argument: "2"}` where `target` is the label of the construction element related to the event (if applicable), `argument` provides additional information based on the event type (e.g. the mode number for setMode event). Please refer to the list of client events below.
void unregisterClientListener(JSFunction function)	5.0	Removes previously registered client listener, see registerClientListener

void registerAddListener(JSFunction function)

3.0

Registers a JavaScript function as an add listener for the applet’s construction. Whenever a new object is created in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the newly created object as its single argument.

Example: First, register a listening JavaScript function:

ggbApplet.registerAddListener(myAddListenerFunction);

When an object "A" is created, the GeoGebra Applet will call the Javascript function

myAddListenerFunction("A");

void unregisterAddListener(JSFunction function)

3.0

Removes a previously registered add listener, see registerAddListener()

void registerRemoveListener(JSFunction function)

3.0

Registers a JavaScript function as a remove listener for the applet’s construction. Whenever an object is deleted from the GeoGebraApplet’s construction, the JavaScript function is called using the name of the deleted object as its single argument. Note: when a construction is cleared, remove is not called for every single object, see registerClearListener().

Example: First, register a listening JavaScript function:

ggbApplet.registerRemoveListener(myRemoveListenerFunction);

When the object "A" is deleted, the GeoGebra Applet will call the Javascript function

myRemoveListenerFunction("A");

void unregisterRemoveListener(JSFunction function)

3.0

Removes a previously registered remove listener, see registerRemoveListener()

void registerUpdateListener(JSFunction function)

3.0

Registers a JavaScript function as a update listener for the applet’s construction. Whenever any object is updated in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the updated object as its single argument. Note: when you only want to listen for the updates of a single object use registerObjectUpdateListener() instead.

Example: First, register a listening JavaScript function:

ggbApplet.registerUpdateListener(myUpdateListenerFunction);

When the object "A" is updated, the GeoGebra Applet will call the Javascript function

myUpdateListenerFunction("A");

void unregisterUpdateListener(JSFunction function)

3.0

Removes a previously registered update listener, see registerUpdateListener()

void registerClickListener(JSFunction function)

5.0

Registers a JavaScript function as a click listener for the applet’s construction. Whenever any object is clicked in the GeoGebraApplet’s construction, the JavaScript function is called using the name of the updated object as its single argument. Note: when you only want to listen for the updates of a single object use registerObjectClickListener() instead.

void unregisterClickListener(JSFunction function)

3.0

Removes a previously registered click listener, see registerClickListener()

void registerObjectUpdateListener(String objName, JSFunction function)

3.0

Registers a JavaScript function as an update listener for a single object. Whenever the object with the given name is updated, the JavaScript function is called using the name of the updated object as its single argument. If objName previously had a mapping JavaScript function, the old value is replaced. Note: all object updated listeners are unregistered when their object is removed or the construction is cleared, see registerRemoveListener() and registerClearListener().

Example: First, register a listening JavaScript function:

ggbApplet.registerObjectUpdateListener("A", myAupdateListenerFunction);

Whenever the object A is updated, the GeoGebra Applet will call the Javascript function

myAupdateListenerFunction();

Note: an object update listener will still work after an object is renamed.

void unregisterObjectUpdateListener(String objName)

3.0

Removes a previously registered object update listener of the object with the given name, see registerObjectUpdateListener()

void registerObjectClickListener(String objName, JSFunction function)

5.0

Registers a JavaScript function as a click listener for a single object. Whenever the object with the given name is clicked, the JavaScript function is called using the name of the updated object as its single argument. If objName previously had a mapping JavaScript function, the old value is replaced. Note: all object click listeners are unregistered when their object is removed or the construction is cleared, see registerRemoveListener() and registerClearListener().

Example: First, register a listening JavaScript function:

ggbApplet.registerObjectClickListener("A", myAclickListenerFunction);

Whenever the object A is clicked, the GeoGebra Applet will call the Javascript function

myAclickListenerFunction();

Note: an object click listener will still work after an object is renamed.

void unregisterObjectClickListener(String objName)

5.0

Removes a previously registered object click listener of the object with the given name, see registerObjectClickListener()

void registerRenameListener(JSFunction function)

3.0

Registers a JavaScript function as a rename listener for the applet’s construction. Whenever an object is renamed in the GeoGebraApplet’s construction, the JavaScript function is called using the old name and the new name of the renamed object as its two arguments.

Example: First, register a listening JavaScript function:

ggbApplet.registerRenameListener(myRenameListenerFunction);

When an object "A" is renamed to "B", the GeoGebra Applet will call the Javascript function

myRenameListenerFunction("A", "B");

void unregisterRenameListener(String objName)

3.0

Removes a previously registered rename listener, see registerRenameListener()

void registerClearListener(JSFunction function)

3.0

Registers a JavaScript function as a clear listener for the applet’s construction. Whenever the construction in the GeoGebraApplet is cleared (i.e. all objects are removed), the JavaScript function is called using no arguments. Note: all update listeners are unregistered when a construction is cleared. See registerUpdateListener() and registerRemoveListener().

Example: First, register a listening JavaScript function:

ggbApplet.registerClearListener(myClearListenerFunction);

When the construction is cleared (i.e. after reseting a construction or opening a new construction file), the GeoGebra Applet will call the Javascript function

myClearListenerFunction();

void unregisterClearListener(JSFunction function)

3.0

Removes a previously registered clear listener, see registerClearListener()

void registerStoreUndoListener(JSFunction function)

4.4

Registers a listener that is called (with no arguments) every time an undo point is created.

void unregisterStoreUndoListener(JSFunction function)

4.4

Removes previously registered listener for storing undo points, see registerStoreUndoListener

void registerClientListener(JSFunction function)

5.0

Registers a JavaScript function as a generic listener for the applet’s construction. The listener receives events as JSON objects of the form

{type: "setMode", target:"", argument: "2"} where target is the label of the construction element related to the event (if applicable), argument provides additional information based on the event type (e.g. the mode number for setMode event). Please refer to the list of client events below.

void unregisterClientListener(JSFunction function)

5.0

Removes previously registered client listener, see registerClientListener

Client Events

These events can be observed using the registerClientListener method

Type Attributes Description

Type	Attributes	Description
addMacro	`argument`: macro name	when new macro is added
addPolygon		polygon construction started
addPolygonComplete	`target`: polygon label	polygon construction finished
algebraPanelSelected		Graphing / Geometry apps: algebra tab selected in sidebar
deleteGeos		multiple objects deleted
deselect	`target`: object name (for single object) or null (deselect all)	one or all objects removed from selection
dragEnd		mouse drag ended
dropdownClosed	`target`: dropdown list name, `index` index of selected item (0 based)	dropdown list closed
dropdownItemFocused	`target`: dropdown list name, `index` index of focused item (0 based)	dropdown list item focused using mouse or keyboard
dropdownOpened	`target`: dropdown list name	dropdown list opened
editorKeyTyped		key typed in editor (Algebra view of any app or standalone Evaluator app)
editorStart	`target:` object label if editing existing object	user moves focus to the editor (Algebra view of any app or standalone Evaluator app)
editorStop	`target`: object label if editing existing object	user (Algebra view of any app or standalone Evaluator app)
export	`argument`: JSON encoded array including export format	export started
mouseDown	`x`: mouse x-coordinate, `y`: mouse y-coordinate	user pressed the mouse button
movedGeos	`argument`: object labels	multiple objects move ended
movingGeos	`argument`: object labels	multible objects are being moved
openDialog	`argument`: dialog ID	dialog is opened (currently just for export dialog)
openMenu	`argument`: submenu ID	main menu or one of its submenus were open
pasteElms	`argument`: pasted objects as XML	pasting multiple objects started
pasteElmsComplete		pasting multiple objects ended
perspectiveChange		perspective changed (e.g. a view was opened or closed)
redo		redo button pressed
relationTool	`argument`: HTML description of the object relation	relation tool used
removeMacro	`argument`: custom tool name	custom tool removed
renameComplete		object renaming complete (in case of chain renames)
renameMacro	`argument`: array [old name, new name]	custom tool was renamed
select	`target`: object label	object added to selection
setMode	`argument`: mode number (see toolbar reference for details)	app mode changed (e.g. a tool was selected)
showNavigationBar	`argument`: "true" or "false"	navigation bar visibility changed
showStyleBar	`argument`: "true" or "false"	style bar visibility changed
sidePanelClosed		side panel (where algebra view is in Graphing Calculator) closed
sidePanelOpened		side panel (where algebra view is in Graphing Calculator) opened
tablePanelSelected		table of values panel selected
toolsPanelSelected		tools panel selected
undo		undo pressed
updateStyle	`target`: object label	object style changed
viewChanged2D	`xZero`: horizontal pixel position of point (0,0), `yZero`: vertical pixel position of point (0,0), `xscale`: ratio pixels / horizontal units, `yscale`: ratio pixels / vertical units, `viewNo`: graphics view number (1 or 2)	graphics view dimensions changed by zooming or panning
viewChanged3D	similar to 2D, e.g. `xZero: 0,yZero: 0,scale: 50,yscale: 50,viewNo: 512,zZero: -1.5,zscale: 50,xAngle: -40,zAngle: 24`	3D view dimensions changed by zooming or panning

addMacro

argument: macro name

when new macro is added

addPolygon

polygon construction started

addPolygonComplete

target: polygon label

polygon construction finished

algebraPanelSelected

Graphing / Geometry apps: algebra tab selected in sidebar

deleteGeos

multiple objects deleted

deselect

target: object name (for single object) or null (deselect all)

one or all objects removed from selection

dragEnd

mouse drag ended

dropdownClosed

target: dropdown list name, index index of selected item (0 based)

dropdown list closed

dropdownItemFocused

target: dropdown list name, index index of focused item (0 based)

dropdown list item focused using mouse or keyboard

dropdownOpened

target: dropdown list name

dropdown list opened

editorKeyTyped

key typed in editor (Algebra view of any app or standalone Evaluator app)

editorStart

target: object label if editing existing object

user moves focus to the editor (Algebra view of any app or standalone Evaluator app)

editorStop

target: object label if editing existing object

user (Algebra view of any app or standalone Evaluator app)

export

argument: JSON encoded array including export format

export started

mouseDown

x: mouse x-coordinate, y: mouse y-coordinate

user pressed the mouse button

movedGeos

argument: object labels

multiple objects move ended

movingGeos

argument: object labels

multible objects are being moved

openDialog

argument: dialog ID

dialog is opened (currently just for export dialog)

openMenu

argument: submenu ID

main menu or one of its submenus were open

pasteElms

argument: pasted objects as XML

pasting multiple objects started

pasteElmsComplete

pasting multiple objects ended

perspectiveChange

perspective changed (e.g. a view was opened or closed)

redo

redo button pressed

relationTool

argument: HTML description of the object relation

relation tool used

removeMacro

argument: custom tool name

custom tool removed

renameComplete

object renaming complete (in case of chain renames)

renameMacro

argument: array [old name, new name]

custom tool was renamed

select

target: object label

object added to selection

setMode

argument: mode number (see toolbar reference for details)

app mode changed (e.g. a tool was selected)

showNavigationBar

argument: "true" or "false"

navigation bar visibility changed

showStyleBar

argument: "true" or "false"

style bar visibility changed

sidePanelClosed

side panel (where algebra view is in Graphing Calculator) closed

sidePanelOpened

side panel (where algebra view is in Graphing Calculator) opened

tablePanelSelected

table of values panel selected

toolsPanelSelected

tools panel selected

undo

undo pressed

updateStyle

target: object label

object style changed

viewChanged2D

xZero: horizontal pixel position of point (0,0), yZero: vertical pixel position of point (0,0), xscale: ratio pixels / horizontal units, yscale: ratio pixels / vertical units, viewNo: graphics view number (1 or 2)

graphics view dimensions changed by zooming or panning

viewChanged3D

similar to 2D, e.g. xZero: 0,yZero: 0,scale: 50,yscale: 50,viewNo: 512,zZero: -1.5,zscale: 50,xAngle: -40,zAngle: 24

3D view dimensions changed by zooming or panning

GeoGebra’s File format

With these methods you can set everything in a construction (see XML Reference ).

Method Signature	Since	Description
void evalXML(String xmlString)	2.7	Evaluates the given XML string and changes the current construction. Note: the construction is NOT cleared before evaluating the XML string.
void setXML(String xmlString)	2.7	Evaluates the given XML string and changes the current construction. Note: the construction is cleared before evaluating the XML string. This method could be used to load constructions.
String getXML()	2.7	Returns the current construction in GeoGebra’s XML format. This method could be used to save constructions.
String getXML(String objName)	3.2	Returns the GeoGebra XML string for the given object, i.e. only the <element> tag is returned.
String getAlgorithmXML(String objName)	3.2	For a dependent GeoElement objName the XML string of the parent algorithm and all its output objects is returned. For a free GeoElement objName "" is returned.
String getFileJSON()	5.0	Gets the current construction as JSON object including the XML and images
String setFileJSON(Object content)	5.0	Sets the current construction from a JSON (object or string) that includes XML and images (try getFileJSON for the precise format)
String getBase64()		Gets the current construction as a base64-encoded .ggb file
String getBase64(function callback)	4.2	Gets the current construction as a base64-encoded .ggb file asynchronously, passes as parameter to the callback function when ready. The callback function should take one parameter (the base64 string).
void setBase64(String [, function callback] )	4.0	Sets the current construction from a base64-encoded .ggb file. If callback function is specified, it is called after the file is loaded.

Method Signature

Since

Description

void evalXML(String xmlString)

2.7

Evaluates the given XML string and changes the current construction. Note: the construction is NOT cleared before evaluating the XML string.

void setXML(String xmlString)

2.7

Evaluates the given XML string and changes the current construction. Note: the construction is cleared before evaluating the XML string. This method could be used to load constructions.

String getXML()

2.7

Returns the current construction in GeoGebra’s XML format. This method could be used to save constructions.

String getXML(String objName)

3.2

Returns the GeoGebra XML string for the given object, i.e. only the <element> tag is returned.

String getAlgorithmXML(String objName)

3.2

For a dependent GeoElement objName the XML string of the parent algorithm and all its output objects is returned. For a free GeoElement objName "" is returned.

String getFileJSON()

5.0

Gets the current construction as JSON object including the XML and images

String setFileJSON(Object content)

5.0

Sets the current construction from a JSON (object or string) that includes XML and images (try getFileJSON for the precise format)

String getBase64()

Gets the current construction as a base64-encoded .ggb file

String getBase64(function callback)

4.2

Gets the current construction as a base64-encoded .ggb file asynchronously, passes as parameter to the callback function when ready. The callback function should take one parameter (the base64 string).

void setBase64(String [, function callback] )

4.0

Sets the current construction from a base64-encoded .ggb file. If callback function is specified, it is called after the file is loaded.

Miscellaneous

Method Signature	Since	Description
void debug(String string)	3.2	Prints the string to the Java Console
String getVersion()	5.0	Returns the version of GeoGebra
void remove()	5.0	Removes the applet and frees up memory

Method Signature

Since

Description

void debug(String string)

3.2

Prints the string to the Java Console

String getVersion()

5.0

Returns the version of GeoGebra

void remove()

5.0

Removes the applet and frees up memory

Obtaining the API Object

If you are loading GeoGebra using the deployggb.js script, you can access the api either as an argument of appletOnLoad or via the getAppletObject method:

const ggb = new GGBApplet({
  appletOnLoad(api1) {
    // api1 provides the applet API
  }
});
ggb.inject(document.body);
const api2 = ggb.getAppletObject(); // api2 is also the API object

For compatibility reasons the API objects can be also accessed via global variables. The name of the global variable is ggbApplet by default and can be overridden by the id parameter passed to new GGBApplet(...). In case you have multiple GeoGebra apps on a page, ggbApplet always contains API of the last active one. In such case you should either avoid using global variables or use set the id parameter explicitly for all apps.

Obtaining the API Object as a module: The ES6 way

You can use math-apps module now to inject the applet the ES6 way too

<script type="module">
    import {mathApps} from 'https://www.geogebra.org/apps/web3d/web3d.nocache.mjs';
    mathApps.create({'width':'800', 'height':'600',
        'showAlgebraInput': 'true',
        'material_id':'MJWHp9en'})
        .inject(document.querySelector("#applet1"));
</script>
<div id="applet1"></div>

Example of using the API:

mathApps.create({'appName':'graphing'})
    .inject(document.querySelector("#plot"))
    .getAPI().then(api => api.evalCommand('f(x)=sin(x)'));